YouTube post API

Get a YouTube community post and its comments

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

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

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

import requests

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

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

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "commentUrl": "<string>",
        "likes": 0,
        "replies": 0,
        "isPinned": true,
        "isHearted": true,
        "isChannelOwner": true,
        "commentId": "<string>",
        "text": "<string>",
        "authorId": "<string>",
        "authorName": "<string>",
        "authorUsername": "<string>",
        "authorUrl": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "repliesCursor": "<string>"
      }
    ],
    "postId": "<string>",
    "postUrl": "<string>",
    "text": "<string>",
    "publishedAt": "2023-11-07T05:31:56Z",
    "likes": 0,
    "comments": 0,
    "imageUrls": [
      "<string>"
    ],
    "videoId": "<string>",
    "videoTitle": "<string>",
    "pollChoices": [
      "<string>"
    ],
    "pollTotalVotes": 0,
    "cursor": "<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

post

Get a YouTube community post and its comments

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

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

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

import requests

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

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

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "commentUrl": "<string>",
        "likes": 0,
        "replies": 0,
        "isPinned": true,
        "isHearted": true,
        "isChannelOwner": true,
        "commentId": "<string>",
        "text": "<string>",
        "authorId": "<string>",
        "authorName": "<string>",
        "authorUsername": "<string>",
        "authorUrl": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "repliesCursor": "<string>"
      }
    ],
    "postId": "<string>",
    "postUrl": "<string>",
    "text": "<string>",
    "publishedAt": "2023-11-07T05:31:56Z",
    "likes": 0,
    "comments": 0,
    "imageUrls": [
      "<string>"
    ],
    "videoId": "<string>",
    "videoTitle": "<string>",
    "pollChoices": [
      "<string>"
    ],
    "pollTotalVotes": 0,
    "cursor": "<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"
  }
}

Returns a YouTube community post and its comments. The post is identified by its URL or ID.

Request

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

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.youtube.post({ postId: "UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.youtube.post(post_id="UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ")
print(result["data"]["results"])

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

stophy youtube post --postId UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ

Response

If successful, the response body contains the standard envelope. data contains the post’s text, images and likes, and results lists its comments. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "postId": "UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ",
    "postUrl": "https://www.youtube.com/post/UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ",
    "text": "Alright, it's that time: https://vote.mkbhd.com\n\nWelcome to the Blind Smartphone Camera Test 2023! 20 smartphones. 3…",
    "publishedAt": "2024-10-05T09:08:44.000Z",
    "likes": 12000,
    "comments": 1041,
    "imageUrls": ["https://yt3.ggpht.com/zy6PEg0QzlzFe8xfDxpAbe1mGV0pXgc-xV1MvQ7rlf_EWjEj_YqN0Y2b7fiaOCdghICsMxy8tDGDaA=s1516-rw-nd-v1"],
    "results": [
      {
        "commentId": "Ugwy052tBWynxReFHN94AaABAg",
        "commentUrl": "https://www.youtube.com/post/UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ?lc=Ugwy052tBWynxReFHN94AaABAg",
        "text": "waiting for the new video, \"Let's Talk About Vehicular Felonies.\"",
        "authorId": "UCjU-RRrNmxYVD5RpCuaKZBw",
        "authorName": "Kirkenheimer15",
        "authorUsername": "Kirkenheimer15",
        "authorUrl": "https://www.youtube.com/channel/UCjU-RRrNmxYVD5RpCuaKZBw",
        "likes": 201,
        "replies": 2,
        "publishedAt": "2025-10-05T14:57:57.000Z",
        "isPinned": false,
        "isHearted": false,
        "isChannelOwner": false,
        "repliesCursor": "4qmFsgLQAhIrRkVjb21tZW50X3Bvc3RfZGV0YWlsX3BhZ2Vfd2ViX3JlcGxpZXNfcGFnZRqgAkVnVndiM04wYzhvQko3SUJKRlZuYTNoWU5tZHJSSGhSTUV…"
      }
    ],
    "cursor": "4qmFsgKFBRIoRkVjb21tZW50X3Bvc3RfZGV0YWlsX3BhZ2Vfd2ViX3RvcF9sZXZlbBrYBEVnVndiM04wYzZvRHR3TUswd0puWlhSZmNtRnVhMlZrWDNOMGN…"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`repliesCursor`	string	A token. Pass it as `comment` to retrieve the replies to this comment.
`publishedAt`	string (ISO 8601)	The publication time, in UTC.
`likes`	integer	The number of likes.

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

Optional parameters

Parameter	Type	Description
`sort`	string	Specifies which comments are returned first. Acceptable values are `top` and `newest`. If unset, defaults to `top`.
`cursor`	string	The pagination token from the previous response.

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

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

YouTube transcript: Accepts videoId. Returns what a YouTube video says, from its captions.
YouTube video: Accepts videoId. Returns a video’s stats, description, chapters and most replayed moments.
YouTube comments: Accepts videoId. Returns a video’s comments, or the replies to one comment.
YouTube related videos: Accepts videoId. Returns the videos YouTube suggests next to a video, equivalent to its Up next list.

Authorizations

Authorization

string

header

required

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

Body

application/json

postUrl

string

Link to the YouTube community post, like https://www.youtube.com/post/UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ. Send this or postId.

postId

string

YouTube community post id, like UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ. Send this or postUrl.

sort

enum<string>

default:top

YouTube's own comment sort.

Available options:

top,

newest

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

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

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods