YouTube Channel

One YouTube channel's home page, answered as the document: `channel`, `about`, `videos_section` (the home tab's shelves, not the Videos tab: no next page), `shorts_section` and `other_channels`.

GET

/v1/youtube/channel

One YouTube channel's home page, answered as the document: channel, about, videos_section (the home tab's shelves, not the Videos tab: no next page), shorts_section and other_channels. A block the channel lacks is left out (a small channel has no Shorts and no other channels). subscribers is YouTube's rounded figure (3.06M is 3,060,000). Not on the home page's data: the join date, total views and every link but the first (about.links is that one). A channel that does not exist is 404 profile_not_found (after two sightings). The request is always made from the US; gl and hl choose the page. zero_retention is not handled.

Authorization

headerX-API-Key<token>

Your API key.

Query Parameters

cancel_token?string

A name you make up for this request (a UUID is fine), so you can later GET /v1/cancel with it. Only you know it, so only you can cancel. Use a new one for every request, retries included: a cancelled token stays cancelled for a few minutes.

Length1 <= length <= 128

channel_id*string

A channel id (UC..., 24 characters), an @handle (the @ may be left off), or a youtube.com/channel/... / youtube.com/@... address.

gl?string

Country of the page, a supported YouTube country.

Default"us"

hl?string

Language of the page, a supported YouTube language.

Default"en"

Response Body

The channel, as the document. When the page could not be parsed, the usual envelope.

application/json

response

The first keys of a document-form answer. Unlike DocumentHead there is no search_information unless the engine has one (there is none for the AI engines, Events, Events Details, Facebook, Tripadvisor Place, Trending Now and the Apple engines' places).

search_metadata*

search_parameters*

The parameters the search ran with, defaults filled in; engine is the engine's name.

search_information?

channel?

about?

videos_section?array<>

shorts_section?array<>

other_channels?array<>

Example Request

curl -X GET 'https://api.justserp.com/v1/youtube/channel?channel_id=%40NHL&gl=us&hl=en'

Example Request

curl -X GET 'https://api.justserp.com/v1/youtube/channel?channel_id=%40NHL&gl=us&hl=en'

Example ResponseSchema

{
  "search_metadata": {
    "id": "string",
    "status": "Success",
    "created_at": "string",
    "request_url": "string",
    "html_url": "string"
  },
  "search_parameters": {},
  "search_information": {},
  "channel": {
    "handle": "string",
    "id": "string",
    "title": "string",
    "subscribers": 0,
    "videos": 0,
    "description": "string",
    "keywords": "string",
    "tags": [
      "string"
    ],
    "available_countries": [
      "string"
    ],
    "facebook_profile_id": "string",
    "badges": [
      "string"
    ],
    "first_link": "string",
    "is_verified": true,
    "is_family_safe": true,
    "banner": "string",
    "avatar": "string"
  },
  "about": {
    "description": "string",
    "subscribers": 0,
    "videos": 0,
    "links": [
      {
        "title": "string",
        "link": "string"
      }
    ]
  },
  "videos_section": [
    {
      "section_title": "string",
      "videos": [
        {
          "position": 0,
          "id": "string",
          "title": "string",
          "link": "string",
          "views": 0,
          "length": "string",
          "published_time": "string",
          "badges": [
            "string"
          ],
          "thumbnail": "string"
        }
      ]
    }
  ],
  "shorts_section": [
    {
      "section_title": "string",
      "shorts": [
        {
          "position": 0,
          "id": "string",
          "title": "string",
          "link": "string",
          "views": 0,
          "thumbnail": "string"
        }
      ]
    }
  ],
  "other_channels": [
    {
      "position": 0,
      "handle": "string",
      "id": "string",
      "title": "string",
      "link": "string",
      "video_count": 0,
      "subscribers": 0
    }
  ]
}

{  "search_metadata": {    "id": "string",    "status": "Success",    "created_at": "string",    "request_url": "string",    "html_url": "string"  },  "search_parameters": {},  "search_information": {},  "channel": {    "handle": "string",    "id": "string",    "title": "string",    "subscribers": 0,    "videos": 0,    "description": "string",    "keywords": "string",    "tags": [      "string"    ],    "available_countries": [      "string"    ],    "facebook_profile_id": "string",    "badges": [      "string"    ],    "first_link": "string",    "is_verified": true,    "is_family_safe": true,    "banner": "string",    "avatar": "string"  },  "about": {    "description": "string",    "subscribers": 0,    "videos": 0,    "links": [      {        "title": "string",        "link": "string"      }    ]  },  "videos_section": [    {      "section_title": "string",      "videos": [        {          "position": 0,          "id": "string",          "title": "string",          "link": "string",          "views": 0,          "length": "string",          "published_time": "string",          "badges": [            "string"          ],          "thumbnail": "string"        }      ]    }  ],  "shorts_section": [    {      "section_title": "string",      "shorts": [        {          "position": 0,          "id": "string",          "title": "string",          "link": "string",          "views": 0,          "thumbnail": "string"        }      ]    }  ],  "other_channels": [    {      "position": 0,      "handle": "string",      "id": "string",      "title": "string",      "link": "string",      "video_count": 0,      "subscribers": 0    }  ]}

YouTube Channel

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body