YouTube youTube Video API

Scrape a YouTube video page

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/video \
  --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/video', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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>",
    "isShort": true,
    "isLive": true,
    "tags": [
      "<string>"
    ],
    "chapters": [
      {
        "startSeconds": 4503599627370495,
        "title": "<string>"
      }
    ],
    "mostReplayedAtSeconds": [
      4503599627370495
    ],
    "videoId": "<string>",
    "title": "<string>",
    "channelId": "<string>",
    "channelName": "<string>",
    "channelUrl": "<string>",
    "channelUsername": "<string>",
    "durationSeconds": 0,
    "views": 0,
    "thumbnailUrl": "<string>",
    "publishedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "likes": 0,
    "category": "<string>",
    "comments": 0,
    "channelSubscribers": 0
  },
  "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

video

Scrape a YouTube video page

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/video \
  --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/video', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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>",
    "isShort": true,
    "isLive": true,
    "tags": [
      "<string>"
    ],
    "chapters": [
      {
        "startSeconds": 4503599627370495,
        "title": "<string>"
      }
    ],
    "mostReplayedAtSeconds": [
      4503599627370495
    ],
    "videoId": "<string>",
    "title": "<string>",
    "channelId": "<string>",
    "channelName": "<string>",
    "channelUrl": "<string>",
    "channelUsername": "<string>",
    "durationSeconds": 0,
    "views": 0,
    "thumbnailUrl": "<string>",
    "publishedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "likes": 0,
    "category": "<string>",
    "comments": 0,
    "channelSubscribers": 0
  },
  "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 page. 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.video({ videoId: "p0fybvFyOlM" });
console.log(result.data.title);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.youtube.video(video_id="p0fybvFyOlM")
print(result["data"]["title"])

curl -X POST https://api.stophy.dev/v1/youtube/video \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"videoId":"p0fybvFyOlM"}'

stophy youtube video --videoId p0fybvFyOlM

Response

If successful, the response body contains the standard envelope. data contains the video’s title, channel, stats, description and tags, plus chapters and most replayed moments when it has them. 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",
    "title": "A total disaster",
    "channelId": "UCUyeluBRhGPCW4rPe_UvBZQ",
    "channelName": "The PrimeTime",
    "channelUrl": "https://www.youtube.com/channel/UCUyeluBRhGPCW4rPe_UvBZQ",
    "channelUsername": "ThePrimeTimeagen",
    "durationSeconds": 799,
    "views": 699503,
    "thumbnailUrl": "https://i.ytimg.com/vi/p0fybvFyOlM/hqdefault.jpg",
    "isShort": false,
    "isLive": false,
    "publishedAt": "2026-10-03T03:48:31.000Z",
    "description": "Sandbox aren't enough. Your agents need a devbox. A full development environment with all your dependencies.…",
    "likes": 10482,
    "category": "Science & Technology",
    "tags": ["programming"],
    "comments": 1100,
    "channelSubscribers": 1170000
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`publishedAt`	string (ISO 8601)	When the video was published.
`durationSeconds`	integer	The duration, in seconds.
`likes`	integer	The number of likes.

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

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 Transcript: Accepts videoUrl. Scrape a YouTube video’s transcript.
YouTube youTube Comments: Accepts videoUrl. Scrape the comments of a YouTube video.
YouTube youTube Channel: Accepts channelUrl. Scrape a YouTube channel and its videos.

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.

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 Video API

Request

Response

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Billing

Pagination

Related methods