Skip to main content
GET
youtube get_related_videos
Get related videos Pricing — billed per successful call; the final charge scales by your plan multiplier. Charged only when the upstream response body code is 200.
Response structure is not yet fully documented — refer to the actual API response.

Example

Authorizations

Authorization
string
header
required

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

Query Parameters

need_format
boolean
default:true

Whether to format data (default true)

  • true: Return formatted structured data (recommended)
  • false: Return raw YouTube API structure (for debugging or custom parsing)
video_id
string

Video ID

video_url
string

Ignored if video_id is provided

Response

Successful response. The outer object follows ResponseModel; the endpoint-specific payload is in data.

Returns

When need_format=true:

  • video_id: Current video ID
  • related_videos: Related videos list
    • video_id: Related video's ID
    • title: Video title
    • author: Author name
    • author_id: Author channel ID
    • author_url: Author channel URL
    • length_text: Video duration text (e.g., "3:45")
    • length_seconds: Video duration in seconds
    • view_count_text: View count text (e.g., "1.2M views")
    • short_view_count_text: Short view count text (e.g., "1.2M")
    • published_time_text: Published time text (e.g., "2 days ago")
    • thumbnails: All resolution thumbnails
    • rich_thumbnail: Moving thumbnail (if available)
    • badges: Video badges (e.g., NEW, LIVE)
    • owner_badges: Channel verification badges
    • video_url: Video URL
    • navigation_endpoint: Navigation endpoint
  • total_count: Total number of recommended videos

When need_format=false:

  • video_id: Current video ID
  • related_videos: Raw lockupViewModel object list
  • total_count: Total number of recommended videos
code
integer
default:200

HTTP status code

request_id
string | null

Unique request identifier

message
string
default:Request successful. This request will incur a charge.

Response message (EN-US)

message_zh
string
default:请求成功,本次请求将被计费。

Response message (ZH-CN)

support
string
default:Discord: https://discord.gg/aMEAS8Xsvz

Support message

time
string

The time the response was generated

time_stamp
integer

The timestamp the response was generated

time_zone
string
default:America/Los_Angeles

The timezone of the response time

docs
string | null

Link to the API Swagger documentation for this endpoint

cache_message
string | null
default:This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again.

Cache message (EN-US)

cache_message_zh
string | null
default:本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。

Cache message (ZH-CN)

cache_url
string | null

The URL to access the cached result

router
string
default:""

The endpoint that generated this response

params
any
default:{}

The parameters used in the request

data
any

Endpoint-specific response payload. The official shared model does not declare a fixed type or field set. Use the operation's documented return fields or response example; an operation-specific schema, when present, describes the documented fields. Undocumented fields must be read from the actual response rather than assumed.