# Spotify Album (`spotify.album`)

A Spotify album by URL or ID with its tracklist, per-track play counts, album total, label and release date.

Docs: https://primaryapi.com/docs/api-reference/spotify/album

- Endpoint: `POST https://api.primaryapi.com/v1/run/spotify.album`
- Category: Audio · Platform: `spotify` · Kind: lookup · Status: live
- Price: 5 credits per call; up to 57 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=spotify.album`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | no |  | max 2048 chars | Spotify album URL, e.g. "https://open.spotify.com/album/4yP0hdKOZPNshxUOjY0cZj". open.spotify.com links (also /intl-xx/ and /embed/ forms) and spotify:album:<id> URIs work. Give url or id. |
| `id` | string | no |  | pattern: ^[A-Za-z0-9]{22}$ | Spotify album ID: the 22-character code after /album/ in the URL (alternative to url). |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string | Spotify album ID |
| `name` | string \| null |  |
| `type` | string \| null | album, single, ep or compilation |
| `url` | string |  |
| `uri` | string |  |
| `artistName` | string \| null | First credited artist |
| `artists` | string[] |  |
| `label` | string \| null |  |
| `releaseDate` | string \| null | YYYY-MM-DD, or YYYY-MM / YYYY when Spotify only knows the month or year |
| `image` | string \| null | Cover art URL |
| `copyrights` | string[] | Copyright (C) and phonogram (P) lines |
| `popularity` | integer \| null |  |
| `trackCount` | integer \| null |  |
| `durationMs` | integer \| null | Sum of the listed track durations |
| `playcount` | integer \| null | Album total: sum of the per-track play counts |
| `tracks` | object[] |  |
| `tracks[].id` | string \| null |  |
| `tracks[].name` | string \| null |  |
| `tracks[].trackNumber` | integer \| null |  |
| `tracks[].durationMs` | integer \| null |  |
| `tracks[].playcount` | integer \| null | All-time streams of this track |
| `tracks[].explicit` | boolean \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/spotify.album" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://open.spotify.com/album/4yP0hdKOZPNshxUOjY0cZj"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "id": "string",
      "name": "string",
      "type": "string",
      "url": "https://open.spotify.com/album/4yP0hdKOZPNshxUOjY0cZj",
      "uri": "string",
      "artistName": "string",
      "artists": [
        "string"
      ],
      "label": "string",
      "releaseDate": "string",
      "image": "string",
      "copyrights": [
        "string"
      ],
      "popularity": 0,
      "trackCount": 0,
      "durationMs": 0,
      "playcount": 0,
      "tracks": [
        {
          "id": "string",
          "name": "string",
          "trackNumber": 0,
          "durationMs": 0,
          "playcount": 0,
          "explicit": true
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 5,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 5 credits per call
- Price ceiling: up to 57 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=spotify.album`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Legal

Spotify terms bar scraping and the official Web API cannot serve a reseller. Cover art and metadata are copyrighted: links are passed through, nothing is re-hosted.

