Skip to main content
GET
Get related videos
This endpoint retrieves a list of videos related to a specified video, in the same order the provider ranks them. The source video is never included in the results, and duplicates across pages are removed. Each page returns up to 20 videos. Use the pages parameter to request more, up to a maximum of 10 pages.
This endpoint is backed by Poix’s related-videos provider rather than the YouTube Data API, so it consumes no YouTube quota units.

Price

The cost of this request is $0.00003 per request plus $0.0005 per page fetched: Only pages that are actually fetched are billed. If the provider runs out of results before reaching the number of pages you requested, you are charged for the pages that were fetched — the pagesFetched field in the response tells you exactly how many that was.

Authorizations

Authorization
string
header
required

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

Query Parameters

videoId
string
required

The ID of the video to retrieve related videos for.

Minimum string length: 1
pages
string
default:1

The number of provider pages to fetch, each returning up to 20 videos. Between 1 and 10. Each page that is actually fetched is billed; if the provider runs out of results early, only the pages that were fetched are charged.

regionCode
enum<string>

Instructs the API to return results as if the request was made from a specific country. The parameter value is an ISO 3166-1 alpha-2 country code.

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AN,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BM,
BN,
BO,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
ST,
SV,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YE,
YT,
ZA,
ZM,
ZW
hl
enum<string>

The language to retrieve localized data in.

Available options:
en,
es,
de,
fr,
ja,
pt,
tr,
it,
fa,
nl,
af,
am,
ar,
as,
az,
be,
bg,
bn,
bs,
ca,
cs,
da,
el,
en-GB,
en-IN,
es-419,
es-US,
et,
eu,
fi,
fil,
fr-CA,
gl,
gu,
hi,
hr,
hu,
hy,
id,
is,
iw,
ka,
kk,
km,
kn,
ko,
ky,
lo,
lt,
lv,
mk,
ml,
mn,
mr,
ms,
my,
no,
ne,
or,
pa,
pl,
pt-PT,
ro,
ru,
si,
sk,
sl,
sq,
sr-Latn,
sr,
sv,
sw,
ta,
te,
th,
uk,
ur,
uz,
vi,
zh-CN,
zh-HK,
zh-TW,
zh-Hans,
zu

Response

Successful response

totalResults
number
required

Total number of related videos returned.

pagesFetched
number
required

The number of provider pages actually fetched for this request. This is what the request was billed for, and it can be lower than the requested pages when the provider has no further results.

data
object[]
required

Array of related video objects.