Example
curl 'https://socialtap.dev/v1/applemusic/top_albums?country=US' \
-H "x-api-key: $SOCIALTAP_API_KEY"import { SocialTap } from "socialtap";
const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY
const res = await client.applemusic.topAlbums.list({ country: "US" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
country: "US",
});
const res = await fetch(`https://socialtap.dev/v1/applemusic/top_albums?${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);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/applemusic/top_albums",
params={"country": "US"},
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"])package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"os"
)
func main() {
q := url.Values{}
q.Set("country", "US")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/applemusic/top_albums?"+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
$query = http_build_query([
'country' => 'US',
]);
$ch = curl_init('https://socialtap.dev/v1/applemusic/top_albums?' . $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;require "json"
require "net/http"
uri = URI("https://socialtap.dev/v1/applemusic/top_albums")
uri.query = URI.encode_www_form('country' => 'US')
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"]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 = "country=" + encode("US");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/applemusic/top_albums?" + 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);
}
}using System.Text.Json;
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));
var query = string.Join("&",
"country=" + Uri.EscapeDataString("US"));
var res = await http.GetAsync("https://socialtap.dev/v1/applemusic/top_albums?" + 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"));// 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/top_albums")
.query(&[("country", "US")])
.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(())
}{
"data": [
{
"approximate_fields": [
"released_at"
],
"artist_name": "BigXthaPlug",
"artists": [
{
"avatar_url": "https://is1-ssl.mzstatic.com/image/thumb/AMCArtistImages221/v4/2d/37/2e/2d372ebd-cf1a-b1f5-2e2e-b8aebb430cf2/ami_U003aidentity_U003a8cd8358dbec0e6453567ddb7d3121e91-2026-10-09T12-14-49.366Z_cropped.png/871x871bb.jpg",
"display_name": "BigXthaPlug",
"id": "1482508209",
"is_verified": null,
"url": "https://music.apple.com/us/artist/bigxthaplug/1482508209",
"username": null
}
],
"copyrights": [
{
"text": "℗ 2026 BigXthaPlug under exclusive license to UnitedMasters LLC",
"type": "p"
}
],
"cover_url": "https://is1-ssl.mzstatic.com/image/thumb/Music211/v4/f2/30/e2/f230e2c5-8527-184a-12f7-442f85567061/711209295424.png/3000x3000bb.jpg",
"description": "On his previous album, 2025’s I Hope You’re Happy, the irrepressible Dallas rapper BigXthaPlug took a break from being the torchbearer for Texas storytelling rap and reinvented himself as a brokenhearted country crooner. That record was BigX’s highest-charting album to date, but …",
"duration_ms": null,
"genres": [
"Hip-Hop/Rap"
],
"id": "6827763091",
"is_explicit": true,
"label": "BigXthaPlug under exclusive license to UnitedMasters LLC",
"metrics": {
"track_count": 19
},
"platform": "applemusic",
"platform_specific": {
"applemusic": {
"audio_traits": [
"atmos",
"lossless",
"lossy-stereo"
],
"content_rating": "explicit",
"editorial_summary": "The Dallas MC returns to his Southern rap roots.",
"is_complete": true,
"is_mastered_for_itunes": false,
"is_prerelease": false,
"more_by_artist": [],
"other_versions": [],
"rank": 1,
"storefront": "us"
}
},
"released_at": "2026-11-02T00:00:00Z",
"title": "BETTER OVER TIME",
"tracks": [],
"type": "album",
"unknown_fields": [
"tracks",
"tracks[].artists",
"platform_specific.applemusic.more_by_artist"
],
"upc": "711209295424",
"url": "https://music.apple.com/us/album/better-over-time/6827763091"
},
{
"approximate_fields": [
"released_at"
],
"artist_name": "Drake",
"artists": [
{
"avatar_url": "https://is1-ssl.mzstatic.com/image/thumb/AMCArtistImages112/v4/1b/71/65/1b716513-b0c1-9c6b-45aa-cbb9198248cc/01607cf1-1d52-43d2-84ce-d6fc1f4a3475_ami-identity-7665599cc626d803af7956b3691905e7-2022-11-30T21-07-19.526Z_cropped.png/1825x1825bb.jpg",
"display_name": "Drake",
"id": "271256",
"is_verified": null,
"url": "https://music.apple.com/us/artist/drake/271256",
"username": null
}
],
"copyrights": [
{
"text": "℗ 2026 OVO, under exclusive license to Republic Records, a division of UMG Recordings, Inc.",
"type": "p"
}
],
"cover_url": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/bb/45/62/bb4562a3-45a2-539c-b557-a18ea060a476/26UMGIM63616.rgb.jpg/4500x4500bb.jpg",
"description": "& other nicknames I call my dear city",
"duration_ms": null,
"genres": [
"R&B/Soul"
],
"id": "6818209777",
"is_explicit": true,
"label": "OVO/Republic",
"metrics": {
"track_count": 24
},
"platform": "applemusic",
"platform_specific": {
"applemusic": {
"audio_traits": [
"lossless",
"lossy-stereo"
],
"content_rating": "explicit",
"editorial_summary": "The 2026 album, now with videos and four previously unreleased tracks.",
"is_complete": true,
"is_mastered_for_itunes": true,
"is_prerelease": false,
"more_by_artist": [],
"other_versions": [],
"rank": 2,
"storefront": "us"
}
},
"released_at": "2026-10-02T00:00:00Z",
"title": "HABIBTI (FOMO)",
"tracks": [],
"type": "album",
"unknown_fields": [
"tracks",
"tracks[].artists",
"platform_specific.applemusic.more_by_artist"
],
"upc": "00881061707059",
"url": "https://music.apple.com/us/album/habibti-fomo/6818209777"
},
{
"approximate_fields": [
"released_at"
],
"artist_name": "Olivia Rodrigo",
"artists": [
{
"avatar_url": "https://is1-ssl.mzstatic.com/image/thumb/AMCArtistImages221/v4/ba/36/7a/ba367a61-9f8a-8905-9dbd-7a99db6ee77b/ami-identity-5b05d351a6e3c7256ef7680c8aef2894-2026-06-12T04-01-34.107Z_cropped.png/972x972bb.jpg",
"display_name": "Olivia Rodrigo",
"id": "979458609",
"is_verified": null,
"url": "https://music.apple.com/us/artist/olivia-rodrigo/979458609",
"username": null
}
],
"copyrights": [
{
"text": "℗ 2026 Olivia Rodrigo, under exclusive license to Geffen Records",
"type": "p"
}
],
"cover_url": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/1d/1b/f9/1d1bf9b1-44c6-9a6c-6ffb-c158488c06ce/26UMGIM39303.rgb.jpg/4000x4000bb.jpg",
"description": "A pop savant raises her game and her standards on her third album. Olivia Rodrigo has loved and lost many times since she cried through the suburbs as the heartbroken teenager in “drivers license.” She’s grown up, and her standards have gotten higher—for a good love song, but als…",
"duration_ms": null,
"genres": [
"Pop"
],
"id": "1889992111",
"is_explicit": true,
"label": "Olivia Rodrigo PS",
"metrics": {
"track_count": 14
},
"platform": "applemusic",
"platform_specific": {
"applemusic": {
"audio_traits": [
"atmos",
"lossless",
"lossy-stereo"
],
"content_rating": "explicit",
"editorial_summary": "A pop savant raises her game and her standards on her third album.",
"is_complete": true,
"is_mastered_for_itunes": true,
"is_prerelease": false,
"more_by_artist": [],
"other_versions": [],
"rank": 3,
"storefront": "us"
}
},
"released_at": "2026-06-12T00:00:00Z",
"title": "you seem pretty sad for a girl so in love",
"tracks": [],
"type": "album",
"unknown_fields": [
"tracks",
"tracks[].artists",
"platform_specific.applemusic.more_by_artist"
],
"upc": "00199957777902",
"url": "https://music.apple.com/us/album/you-seem-pretty-sad-for-a-girl-so-in-love/1889992111"
}
],
"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": 336,
"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.
Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive). The Apple Music store whose chart to read: each has its own. A country with no Apple Music store returns invalid_input. Default: US. UK is read as GB.
ExampleJP
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
Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged.
Example2026-10-01
Only items before this time (exclusive): RFC 3339 or a date (midnight UTC).
Example2026-10-08
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
cursorstringpage.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
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.
fieldsstringReturn 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
200
{data, page, meta}. data is an array of up to 50 album objects, Apple Music's own chart order (1 = most played); page says how to get the next page; meta describes the request (meta). Fields only Apple Music has are under platform_specific.applemusic.
platformstringPlatform ID (applemusic, spotify, soundcloud, …).
idstringPlatform-native album ID (string), the one in its page's URL.
urlstring uriCanonical album page URL.
typestringnullableWhat kind of release it is, as the platform says: album, single, ep or compilation; null when the platform does not say. New values may be added; treat unknown values as album.
One ofalbumsingleepcompilation
titlestringThe release's title as the platform shows it (with an edition or a suffix like "- Single" where it writes one).
descriptionstringnullableAbout the release, as plain text (the service's editorial notes, or what its uploader wrote); null when it has none or the platform shows none.
artist_namestringnullableWho the platform credits for the release, as one display string (it can name more people than have an account linked: artists holds the linked ones); null when the source does not name them.
artistsobject[]The platform accounts of the artists credited on the release, main artist first, in the platform's order; [] when none is linked, as on a Various Artists compilation (listed in unknown_fields when the source cannot see them).
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
cover_urlstring urinullableCover art URL at the largest size the platform serves; null when it has none.
released_atstring date-timenullableWhen it was released, RFC 3339 UTC. A release date with no time (nearly all) is midnight UTC of that date, listed in approximate_fields, and so is a year or month alone (its first day). Null when the platform states none.
labelstringnullableThe record label as the platform names it; null when none is shown.
upcstringnullableThe release's barcode: its UPC or EAN, digits only; null when the platform does not show it.
copyrightsobject[]The release's copyright lines as the platform shows them; [] when none.
ShowHide 2 child fields
typestringnullablec: the copyright in the work (©); p: in the sound recording (℗); null when the line does not say or states both. New values may be added.
One ofcp
textstringThe line as the platform shows it.
genresstring[]Genres the platform files it under, as shown (not normalized), the main one first; [] when none (listed in unknown_fields when the source cannot see them).
is_explicitbooleannullableMarked as holding explicit content (by the platform, or on any of its tracks); null when the platform does not say.
duration_msintegernullableTotal length of the release in milliseconds; null when neither the platform nor a complete tracks list gives it.
tracksobject[]The release's tracks in album order (by disc, then track number). A list of albums, whose source shows none, answers [] and lists tracks in unknown_fields; a list the source could only read part of is listed in approximate_fields.
ShowHide 12 child fields
idstringPlatform-native track ID (string): the one the platform's track endpoint takes and answers.
urlstring urinullableThe track's page; null when the source does not show it.
titlestringnullableThe track's title as the platform shows it; null when the source names the track only by its ID.
artist_namestringnullableWho the platform credits for this track, as one display string (a feature included); null when the source does not name them.
artistsobject[]The platform accounts of the artists credited on this track, in the platform's order; [] when none is linked (listed in unknown_fields as tracks[].artists when the source cannot see them).
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
track_numberintegernullableIts position on its disc, from 1; null when the source does not state it (tracks stay in album order).
disc_numberintegernullableThe disc it is on, from 1; null when the platform does not say (a release of one disc, on platforms without discs).
duration_msintegernullableLength of the track in milliseconds; null when the source does not state it.
is_explicitbooleannullableMarked as explicit by the platform; null when it does not say.
isrcstringnullableInternational Standard Recording Code, 12 characters without hyphens; null when the platform does not show it.
play_urlstring urinullableAudio file URL: a short preview, where the platform serves only one. Signed links expire within hours; null when not exposed.
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
ShowHide 1 child field
view_countintegernullablePlays; null when the platform does not show them.
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
ShowHide 1 child field
track_countintegernullableTracks on the release as the platform counts them, null when it does not state a count; tracks answers fewer only when listed in approximate_fields or unknown_fields.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
applemusicobjectnullableAn Apple Music album's own fields.
ShowHide 10 child fields
storefrontstringnullableThe Apple Music store this answer is from, as a lowercase country code (us, jp): titles, availability, track lists and links differ by store.
rankintegernullablePosition on the requested chart (1 = top); null off a chart.
editorial_summarystringnullableApple's one-line note on the album; null when none.
content_ratingstringnullableexplicit, or clean for an edited version of something explicit; null when Apple marks neither.
audio_traitsstring[]The audio formats it comes in (atmos, lossless, lossy-stereo, spatial, …); [] when none or the source does not show them (listed in unknown_fields). New values may be added.
is_completebooleannullableEvery track of the release is available in this store.
is_prereleasebooleannullableAnnounced, and not released yet.
is_mastered_for_itunesbooleannullableCarries Apple's Mastered for iTunes badge, which Apple now calls Apple Digital Master.
more_by_artistobject[]Apple's other releases by the same artist, as many as its page shows at first; [] when none or the source does not show them (listed in unknown_fields).
ShowHide 10 child fields
idstringApple Music's ID of the item (string).
kindstringWhat it is. New values may be added.
One ofsongmusic_videoalbumplaylistartiststation
urlstring urinullableIts page; null when Apple does not state it.
titlestringnullableIts title, or an artist's name.
artist_namestringnullableWho Apple credits for it, or a playlist's curator; null on an artist.
cover_urlstring urinullableIts artwork at the largest size Apple states; null when none.
released_atstring date-timenullableIts release date, midnight UTC of that date; null when Apple does not state it.
track_countintegernullableAn album's tracks, null on other kinds.
duration_msintegernullableA song's or music video's length in milliseconds, null on other kinds.
is_explicitbooleannullableApple marks it explicit; null on kinds it does not mark.
other_versionsobject[]Other versions of the release (the clean or explicit one, a deluxe edition); [] when none or the source does not show them (listed in unknown_fields).
ShowHide 10 child fields
idstringApple Music's ID of the item (string).
kindstringWhat it is. New values may be added.
One ofsongmusic_videoalbumplaylistartiststation
urlstring urinullableIts page; null when Apple does not state it.
titlestringnullableIts title, or an artist's name.
artist_namestringnullableWho Apple credits for it, or a playlist's curator; null on an artist.
cover_urlstring urinullableIts artwork at the largest size Apple states; null when none.
released_atstring date-timenullableIts release date, midnight UTC of that date; null when Apple does not state it.
track_countintegernullableAn album's tracks, null on other kinds.
duration_msintegernullableA song's or music video's length in milliseconds, null on other kinds.
is_explicitbooleannullableApple marks it explicit; null on kinds it does not mark.
approximate_fieldsstring[]JSON paths of values that are date-only, rounded by the platform or parsed from display text (released_at from a date, duration_ms from "1 hour 1 minute"). A list path means the list may be incomplete. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see them), tracks[].artists for that list on every track; 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 retryA 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 retryThe 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 retryThe 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 retryThe 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 retryThe 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 retryThe 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.
404
404 Not Found: 1 error code. Free: errors cost nothing.
not_foundNo retryThe 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, laterThe 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, laterAn 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, laterThe 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, laterThe platform refused every attempt, our own retries included.
Retry later with backoff. Failed requests are free.
overloadedYes, laterSocialTap 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.
Items come in pages, Apple Music's own chart order (1 = most played). 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).
The page object
has_morebooleanTrue when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
next_cursorstringnullablePass as cursor, with the same other parameters, to get the next page; null at the end.
next_cursor_expires_atstring date-timenullableWhen next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.
end_reasonstringnullableWhy 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 'https://socialtap.dev/v1/applemusic/top_albums?country=US&cursor=c1.EXAMPLE_CURSOR' \
-H "x-api-key: $SOCIALTAP_API_KEY"- The price is per page: each successful page costs the same, whatever
limitis and however many items it has. Empty pages are charged too (an empty page withhas_more: trueis not the end). - A
limitbelow 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. Omittinglimitis 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.
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.
| Source | Price per successful page | Per 1,000 pages |
|---|---|---|
Platform API api | 1 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.source | Source | What it means |
|---|---|---|
api | Platform API | The 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.top_albums · operationId applemusic.top_albums.list · Product overview