---
title: "Retrieve Spotify popular by country"
method: GET
path: "/spotify/popular-by-country"
tags: ["Spotify"]
---

# Retrieve Spotify popular by country

`GET /spotify/popular-by-country`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/spotify/popular-by-country`
- Auth: API key in header `x-api-key`

Returns Spotify country hub shelves. The country_code parameter accepts Spotify popular-in country codes from open.spotify.com/popular-in/us.

## Query parameters

- `country_code` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- SpotifyCountryHubResponseDoc
  - `code` integer: Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
  - `data` SpotifyCountryHubResponse
    - `countryCode` string: Country code the hub was loaded for.
    - `countryName` string: Name of the country.
    - `hexColor` string: Accent color of the country page, as a hex color code.
    - `meta` SpotifyCountryHubMeta
      - `appVersion` string: Version of the Spotify web player the data was read from.
      - `fetchedAt` string: Time the data was fetched, in UTC (RFC 3339).
      - `itemCount` integer: Number of items returned across all sections.
      - `operationName` string: Name of the Spotify web player operation that returned the data.
      - `partialErrors` integer: PartialErrors counts upstream GraphQL field errors that were tolerated because usable shelves were still returned (e.g. one broken shelf among several). Zero on a fully clean response.
      - `sectionCount` integer: Number of sections returned.
    - `sections` SpotifyCountryHubSection[]: Content sections of the country page.
      - `contentId` string: Identifier of the section content, for example `CHARTS`.
      - `items` SpotifyCountryHubItem[]: Items returned for this section.
        - `album` SpotifySearchResultSummary
          - `description` string: Description text of the result.
          - `externalUrl` string: Link to the result on open.spotify.com.
          - `imageUrl` string: URL of the main image for the result.
          - `images` SpotifyImageAsset[]: Images available for the result, with their sizes.
            - `height` integer: Image height in pixels.
            - `url` string: URL of the image.
            - `width` integer: Image width in pixels.
          - `publisher` string: Publisher or creator name of the result.
          - `subtitle` string: Secondary line shown under the title, such as the artist or creator name.
          - `title` string: Result title as Spotify shows it.
          - `type` string: Kind of result as Spotify labels it, for example `Podcast`.
          - `uri` string: Spotify URI of the result.
        - `artists` SpotifySearchResultSummary[]: Artists credited on the item.
          - `description` string: Description text of the result.
          - `externalUrl` string: Link to the result on open.spotify.com.
          - `imageUrl` string: URL of the main image for the result.
          - `images` SpotifyImageAsset[]: Images available for the result, with their sizes.
            - `height` integer: Image height in pixels.
            - `url` string: URL of the image.
            - `width` integer: Image width in pixels.
          - `publisher` string: Publisher or creator name of the result.
          - `subtitle` string: Secondary line shown under the title, such as the artist or creator name.
          - `title` string: Result title as Spotify shows it.
          - `type` string: Kind of result as Spotify labels it, for example `Podcast`.
          - `uri` string: Spotify URI of the result.
        - `attributes` object: Additional key-value attributes Spotify returns for the item.
        - `description` string: Description text of the item.
        - `externalUrl` string: Link to the item on open.spotify.com.
        - `imageUrl` string: URL of the main image for the item.
        - `images` SpotifyImageAsset[]: Images available for the item, with their sizes.
          - `height` integer: Image height in pixels.
          - `url` string: URL of the image.
          - `width` integer: Image width in pixels.
        - `owner` SpotifySearchResultSummary
          - `description` string: Description text of the result.
          - `externalUrl` string: Link to the result on open.spotify.com.
          - `imageUrl` string: URL of the main image for the result.
          - `images` SpotifyImageAsset[]: Images available for the result, with their sizes.
            - `height` integer: Image height in pixels.
            - `url` string: URL of the image.
            - `width` integer: Image width in pixels.
          - `publisher` string: Publisher or creator name of the result.
          - `subtitle` string: Secondary line shown under the title, such as the artist or creator name.
          - `title` string: Result title as Spotify shows it.
          - `type` string: Kind of result as Spotify labels it, for example `Podcast`.
          - `uri` string: Spotify URI of the result.
        - `subtitle` string: Secondary line shown under the item title.
        - `title` string: Item title as Spotify shows it.
        - `type` string: Kind of item as Spotify labels it, for example `Playlist`.
        - `uri` string: Spotify URI of the item.
      - `title` string: Section heading as Spotify shows it.
      - `totalCount` integer: Total number of items in the section on Spotify.
    - `supportedCountries` SpotifyPopularCountry[]: Countries Spotify offers a popular-in page for.
      - `code` string
      - `name` string: Country name in English.
  - `msg` unknown

## Other responses

- `400`: Missing or invalid parameters
- `429`: Rate limit exceeded
- `503`: Spotify upstream request failed

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)