YouTube youTube Transcript API

Scrape a YouTube video's transcript

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/transcript \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "videoId": "p0fybvFyOlM"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({videoId: 'p0fybvFyOlM'})
};

fetch('https://api.stophy.dev/v1/youtube/transcript', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/youtube/transcript"

payload = { "videoId": "p0fybvFyOlM" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "videoUrl": "<string>",
    "isAutoGenerated": true,
    "videoId": "<string>",
    "language": "<string>",
    "durationSeconds": 123,
    "transcribedSeconds": 123,
    "text": "<string>",
    "segments": [
      {
        "startSeconds": 123,
        "endSeconds": 123,
        "text": "<string>"
      }
    ]
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

youtube

transcript

Scrape a YouTube video's transcript

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/transcript \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "videoId": "p0fybvFyOlM"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({videoId: 'p0fybvFyOlM'})
};

fetch('https://api.stophy.dev/v1/youtube/transcript', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/youtube/transcript"

payload = { "videoId": "p0fybvFyOlM" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "videoUrl": "<string>",
    "isAutoGenerated": true,
    "videoId": "<string>",
    "language": "<string>",
    "durationSeconds": 123,
    "transcribedSeconds": 123,
    "text": "<string>",
    "segments": [
      {
        "startSeconds": 123,
        "endSeconds": 123,
        "text": "<string>"
      }
    ]
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape a YouTube video’s transcript. The video is identified by its URL or ID.

Request

Exactly one of videoUrl or videoId is required. A request that sets both, or none, fails with invalidRequest.

This endpoint can be called without an API key, subject to per-address limits. Pagination requires a key.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.youtube.transcript({ videoUrl: "https://www.youtube.com/watch?v=dQw4w9WgXcQ" });
console.log(result.data.text);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.youtube.transcript(video_url="https://www.youtube.com/watch?v=dQw4w9WgXcQ")
print(result["data"]["text"])

curl -X POST https://api.stophy.dev/v1/youtube/transcript \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"videoUrl":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}'

stophy youtube transcript --videoUrl "https://www.youtube.com/watch?v=dQw4w9WgXcQ"

Response

If successful, the response body contains the standard envelope. data contains what the video says as one block of text. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "videoId": "p0fybvFyOlM",
    "videoUrl": "https://www.youtube.com/watch?v=p0fybvFyOlM",
    "language": "ar",
    "isAutoGenerated": true,
    "durationSeconds": 799,
    "text": "يا للهول. شيء جديد على وشك الحدوث. حسناً، سنرى شيئاً جديداً قادماً من OpenAI. هذا صحيح. سنحصل على شيء مذهل. وهل تعرف…"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`text`	string	The whole transcript as one block.
`isAutoGenerated`	boolean	`true` if YouTube wrote the captions, not a person.
`language`	string	The language of the transcript.
`durationSeconds`	number	The duration, in seconds.

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

Optional parameters

Parameter	Type	Description
`language`	string	The language of the results, as a BCP 47 tag such as `en` or `pt-BR`.
`includeTimestamps`	boolean	Return each line with its start and end time, in `segments`. If unset, defaults to `false`.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

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

YouTube youTube Video: Accepts videoUrl. Scrape a YouTube video page.
YouTube youTube Comments: Accepts videoUrl. Scrape the comments of a YouTube video.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json

videoUrl

string

Link to the YouTube video, like https://youtu.be/p0fybvFyOlM. Send this or videoId.

videoId

string

YouTube video id, like p0fybvFyOlM. Send this or videoUrl.

language

string

BCP 47 language tag, e.g. en or pt-BR. Any case is accepted.

Pattern: ^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$

includeTimestamps

boolean

default:false

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

YouTube youTube Transcript API

Request

Response

Optional parameters

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods