> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# YouTube charts API

> Get YouTube Charts: top songs, videos, artists, Shorts songs, podcasts or trending. Call the YouTube charts API for JSON. From 1 credit per call.

Returns YouTube Charts: top songs, videos, artists, Shorts songs, podcasts or trending.

## Request

This method has no required parameters.

<CodeGroup>
  ```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.youtube.charts({ chart: "topSongs", country: "us" });
  console.log(result.data.results);
  ```

  ```python Python icon="python" theme={null} theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.youtube.charts(chart="topSongs", country="us")
  print(result["data"]["results"])
  ```

  ```bash cURL icon="terminal" theme={null} theme={null}
  curl -X POST https://api.stophy.dev/v1/youtube/charts \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"chart":"topSongs","country":"us"}'
  ```

  ```bash CLI icon="square-terminal" theme={null} theme={null}
  stophy youtube charts --chart topSongs --country us
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data.results[]` contains the chart entries in order, each with its position.

The following example is a real response, truncated: each list shows one item and long strings are cut.

```json theme={null}
{
  "success": true,
  "data": {
    "chart": "topSongs",
    "country": "us",
    "throughDate": "2026-10-01",
    "results": [
      {
        "position": 1,
        "periodsOnChart": 1,
        "title": "Patient Zero",
        "artists": ["Taylor Swift"],
        "views": 7084018,
        "videoId": "BpR280fXISA",
        "videoUrl": "https://www.youtube.com/watch?v=BpR280fXISA",
        "releaseDate": "2026-09-25",
        "label": "Taylor Swift"
      }
    ]
  },
  "creditsUsed": 10,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `throughDate` | string (date) | The last day the chart covers. |
| `periodsOnChart` | integer | Weeks on the chart, or days for a daily chart. |
| `position` | integer | The 1-based position of the result in the list. |

For every field, see the response schema on this page.

## Optional parameters

| Parameter | Type | Description |
| - | - | - |
| `chart` | string | Specifies which chart to read. Acceptable values are `topSongs`, `topVideos`, `topArtists`, `topShortsSongs`, `topPodcasts` and `trending`. If unset, defaults to `topSongs`. |
| `country` | string | Two-letter country code, or `global`. If unset, defaults to `us`. |
| `interval` | string | `daily` is only available for `topVideos` and `topShortsSongs`. Acceptable values are `weekly` and `daily`. If unset, defaults to `weekly`. |
| `limit` | integer | The maximum number of results to return. Billed at 1 credit per 10 returned. Must be between 1 and 100. |

## Billing

A successful request consumes 1 credit per 10 results, up to 10 credits. Requests that fail, or that return no items, are not billed. Set `limit` to cap the number of items returned and billed.

## Pagination

This method is not paginated. A single request returns the complete result.

## Related methods

* [YouTube transcript](/api-reference/endpoint/youtube-transcript): Accepts `videoUrl`. Returns what a YouTube video says, from its captions.
* [YouTube video](/api-reference/endpoint/youtube-video): Accepts `videoUrl`. Returns a video's stats, description, chapters and most replayed moments.
* [YouTube comments](/api-reference/endpoint/youtube-comments): Accepts `videoUrl`. Returns a video's comments, or the replies to one comment.
* [YouTube channel](/api-reference/endpoint/youtube-channel): Accepts `channelUrl`. Returns a channel's profile and one tab of videos, shorts, live, playlists, podcasts or posts.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/youtube/charts
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/youtube/charts:
    post:
      summary: >-
        Get YouTube Charts: top songs, videos, artists, Shorts songs, podcasts
        or trending
      description: Costs 1 credit per 10 results.
      operationId: youtubeCharts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                chart:
                  default: topSongs
                  description: YouTube Charts' own chart.
                  type: string
                  enum:
                    - topSongs
                    - topVideos
                    - topArtists
                    - topShortsSongs
                    - topPodcasts
                    - trending
                country:
                  default: us
                  description: >-
                    One of YouTube Charts' own countries as a 2-letter code, or
                    global.
                  type: string
                interval:
                  default: weekly
                  description: Daily exists for topVideos and topShortsSongs only.
                  type: string
                  enum:
                    - weekly
                    - daily
                limit:
                  description: >-
                    Return at most this many results. You pay 1 credit per 10
                    returned.
                  type: integer
                  minimum: 1
                  maximum: 100
              additionalProperties: false
            example:
              chart: topSongs
              country: us
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      chart:
                        type: string
                      country:
                        type: string
                      throughDate:
                        description: The last day the chart covers.
                        type: string
                        format: date
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                      results:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            position:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                            previousPosition:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                            periodsOnChart:
                              description: Weeks on the chart, or days for a daily chart.
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            viewsChangePercent:
                              type: number
                            title:
                              type: string
                            artists:
                              type: array
                              items:
                                type: string
                            views:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            videoId:
                              type: string
                            videoUrl:
                              type: string
                              format: uri
                            channelId:
                              type: string
                            channelUrl:
                              type: string
                              format: uri
                            playlistUrl:
                              type: string
                              format: uri
                            durationSeconds:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            releaseDate:
                              type: string
                              format: date
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                            label:
                              type: string
                          required:
                            - position
                    required:
                      - results
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - inviteClaimed
                - inviteDisabled
                - inviteExpired
                - inviteUsedUp
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
            requiredCredits:
              type: number
            availableCredits:
              type: number
            billingUrl:
              type: string
              const: https://stophy.dev/billing
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.