YouTube channel search API

Search one channel's videos, like the search box on its YouTube page

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/channel/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "elon musk",
  "channelId": "@lexfridman"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'elon musk', channelId: '@lexfridman'})
};

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

import requests

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

payload = {
    "query": "elon musk",
    "channelId": "@lexfridman"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "video",
        "videoUrl": "<string>",
        "isShort": true,
        "isLive": true,
        "videoId": "<string>",
        "title": "<string>",
        "channelId": "<string>",
        "channelName": "<string>",
        "channelUrl": "<string>",
        "channelUsername": "<string>",
        "durationSeconds": 0,
        "views": 0,
        "thumbnailUrl": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "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

channel

Search one channel's videos, like the search box on its YouTube page

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/channel/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "elon musk",
  "channelId": "@lexfridman"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'elon musk', channelId: '@lexfridman'})
};

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

import requests

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

payload = {
    "query": "elon musk",
    "channelId": "@lexfridman"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "video",
        "videoUrl": "<string>",
        "isShort": true,
        "isLive": true,
        "videoId": "<string>",
        "title": "<string>",
        "channelId": "<string>",
        "channelName": "<string>",
        "channelUrl": "<string>",
        "channelUsername": "<string>",
        "durationSeconds": 0,
        "views": 0,
        "thumbnailUrl": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "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"
  }
}

Searches one channel’s videos, equivalent to the search box on its YouTube page. The channel is identified by its URL or ID.

Request

query is required. Exactly one of channelUrl or channelId 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.channel.search({ query: "elon musk", channelId: "@lexfridman" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.youtube.channel.search(query="elon musk", channel_id="@lexfridman")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/youtube/channel/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"elon musk","channelId":"@lexfridman"}'

stophy youtube channel search "elon musk" --channelId @lexfridman

Response

If successful, the response body contains the standard envelope. data.results[] contains the channel’s videos that match the query. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "video",
        "videoId": "JN3KPFbWCy8",
        "videoUrl": "https://www.youtube.com/watch?v=JN3KPFbWCy8",
        "title": "Elon Musk: War, AI, Aliens, Politics, Physics, Video Games, and Humanity | Lex Fridman Podcast #400",
        "channelId": "UCSHZKyawb77ixDdsGog4iWA",
        "channelName": "Lex Fridman",
        "channelUrl": "https://www.youtube.com/channel/UCSHZKyawb77ixDdsGog4iWA",
        "channelUsername": "lexfridman",
        "durationSeconds": 8207,
        "views": 14306823,
        "thumbnailUrl": "https://i.ytimg.com/vi/JN3KPFbWCy8/hqdefault.jpg",
        "isShort": false,
        "isLive": false,
        "publishedAt": "2024-10-05T09:08:36.000Z"
      }
    ],
    "cursor": "4qmFsgJ5EhhVQ1NIWkt5YXdiNzdpeERkc0dvZzRpV0EaJkNCNFNCbk5sWVhKamFEQUJPQUZnQVdvQWVnTkhRalM0QVFBJTNEWgllbG9uIG11c2uaAilicm9…"
  },
  "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.
`type`	string	The kind of item: `video`.
`publishedAt`	string (ISO 8601)	Approximate. YouTube lists show only how long ago a video was published. YouTube video has the exact time.
`durationSeconds`	integer	The duration, in seconds.

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

Optional parameters

Parameter	Type	Description
`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 channel: Accepts channelUrl. Returns a channel’s profile and one tab of videos, shorts, live, playlists, podcasts or posts.
YouTube transcript: Accepts videoUrl. Returns what a YouTube video says, from its captions.
YouTube video: Accepts videoUrl. Returns a video’s stats, description, chapters and most replayed moments.
YouTube comments: Accepts videoUrl. Returns a video’s comments, or the replies to one comment.

Authorizations

Authorization

string

header

required

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

Body

application/json

query

string

required

Required string length: 1 - 200

channelUrl

string

Link to the YouTube channel, like https://www.youtube.com/@mkbhd. Send this or channelId.

channelId

string

YouTube channel handle or id, like @mkbhd. Send this or channelUrl.

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 channel search 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