Docs menu

Spotify API endpoint

Retrieve Spotify home sections

Returns normalized shelves and items from Spotify's Web Player home Pathfinder response. The endpoint fetches anonymous Spotify credentials at request time; caller-supplied Spotify bearer or client tokens are not required.

GETapiKey3 credits/requestSpotifyspotify.homeResponseDoc/spotify/home

Overview

Returns normalized shelves and items from Spotify's Web Player home Pathfinder response. The endpoint fetches anonymous Spotify credentials at request time; caller-supplied Spotify bearer or client tokens are not required.

Request schema

NameInTypeRequiredEnumExampleDescription
time_zonequerystringNoAsia/ShanghaiIANA time zone used by Spotify home personalization
sp_tquerystringNo00000000-0000-4000-8000-000000000000Optional Spotify session token. A random UUID is generated when omitted
facetquerystringNoOptional Spotify home facet
section_items_limitqueryintegerNo10Per-section item limit, clamped to 1-50
include_episode_content_ratings_v2querybooleanNofalseInclude Spotify episode content ratings v2
x-api-keyheaderstringYesAPI key required

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost
3 credits/request
Charged response
Successful 2xx responses
PlanPriceIncluded creditsDaily capRate limitOverage
Free$0/mo2,000500 daily credits5/minNo overage
Starter$9/mo20,0005,000 daily credits15/min$0.75/1,000 overage credits when enabled
Growth$29/mo100,00025,000 daily credits45/min$0.45/1,000 overage credits when enabled
Pro$79/mo400,000No daily cap120/min$0.30/1,000 overage credits
Business$199/mo1,200,000No daily cap300/min$0.20/1,000 overage credits
Enterprise$499/mo5,000,000No daily cap1,000/min$0.12/1,000 overage credits

Infrastructure behavior

This endpoint is executed through Crawlora's managed scraping infrastructure.

  • Proxy strategy: managed automatically where needed
  • Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
  • Browser cluster: supported dynamic workloads can be routed through distributed browser instances
  • Retry behavior: automatic retry/fallback may be used depending on endpoint type
  • Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
  • Billing: credits are charged only for successful 2xx responses
  • Observability: responses include request context where available

Response behavior

- Upstream token, app config, or Pathfinder failures return `502`. - The response includes normalized section titles, item metadata, image assets, external Spotify URLs, and fetch metadata. Example response: ```json { "code": 200, "msg": "OK", "data": { "timeZone": "UTC", "greeting": "Good evening", "sections": [ { "title": "Shows to try", "items": [ { "uri": "spotify:show:1QQJ7FElLE0K6CIfZNCxU4", "type": "Podcast", "title": "Example Show", "imageUrl": "https://i.scdn.co/image/example", "externalUrl": "https://open.spotify.com/show/1QQJ7FElLE0K6CIfZNCxU4" } ] } ], "meta": { "operationName": "home", "appVersion": "1.2.90.373.g86862e17", "sectionCount": 1, "fetchedAt": "2026-05-13T15:22:41Z" } } } ```

Error behavior

Crawlora does not silently return bad data when the upstream page cannot be used.

StatusCommon failure case
400Invalid input or missing required parameter
429Plan or endpoint rate limit exceeded
500Internal execution error
502Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved

When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.

Failure responses

StatusDescriptionSchema
400Missing or invalid parameters#/definitions/app.Response
429Rate limit exceeded#/definitions/app.Response
502Spotify upstream request failed#/definitions/app.Response

Example response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "timeZone": "UTC",
    "greeting": "Good evening",
    "sections": [
      {
        "title": "Shows to try",
        "items": [
          {
            "uri": "spotify:show:1QQJ7FElLE0K6CIfZNCxU4",
            "type": "Podcast",
            "title": "Example Show",
            "imageUrl": "https://i.scdn.co/image/example",
            "externalUrl": "https://open.spotify.com/show/1QQJ7FElLE0K6CIfZNCxU4"
          }
        ]
      }
    ],
    "meta": {
      "operationName": "home",
      "appVersion": "1.2.90.373.g86862e17",
      "sectionCount": 1,
      "fetchedAt": "2026-05-13T15:22:41Z"
    }
  }
}

Request schema

No body schema

Response schema

#/definitions/spotify.homeResponseDoc

FieldTypeRequiredEnumBoundsExampleDescription
codeintegerNoCode is the HTTP status code or a custom code used to indicate the result of the request @example 200
dataspotify.HomeResponseNo
data.facetstringNomusic
data.greetingstringNoGood afternoon
data.metaspotify.HomeMetaNo
data.meta.appVersionstringNo1.2.90.403.gf901f20f
data.meta.fetchedAtstringNo2026-05-13T20:41:12Z
data.meta.operationNamestringNohome
data.meta.sectionCountintegerNo8
data.sectionsarrayNo
data.sections[].itemsarrayNo
data.sections[].items[].descriptionstringNoThe official podcast of comedian Joe Rogan.
data.sections[].items[].externalUrlstringNohttps://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk
data.sections[].items[].imageUrlstringNohttps://i.scdn.co/image/ab67656300005f1f54e6837957803d762a3f4d2b
data.sections[].items[].imagesarrayNo
data.sections[].items[].images[].heightintegerNo640
data.sections[].items[].images[].urlstringNohttps://i.scdn.co/image/ab6765630000ba8ab0484f8ee2933eceab32bac0
data.sections[].items[].images[].widthintegerNo640
data.sections[].items[].publisherstringNoJoe Rogan
data.sections[].items[].subtitlestringNoJoe Rogan
data.sections[].items[].titlestringNoThe Joe Rogan Experience
data.sections[].items[].typestringNoPodcast
data.sections[].items[].uristringNospotify:show:4rOoJ6Egrf8K2IrywzwOMk
data.sections[].subtitlestringNoRecommended shows
data.sections[].titlestringNoPopular podcasts
data.sections[].totalCountintegerNo20
data.sections[].typestringNoBrowseGenericSectionData
data.sections[].uristringNospotify:section:0JQ5IMCbQBLqNPkcmYxQPQ
data.timeZonestringNoUTC
msgunknownNoMsg is the message that describes the result of the request @example "Request successful"

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/spotify/home?time_zone=Asia%2FShanghai&sp_t=00000000-0000-4000-8000-000000000000&facet=&section_items_limit=10&include_episode_content_ratings_v2=false" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.

Read Crawlora terms

Related