POST
/
batch
/
channels

This endpoint allows you to retrieve multiple channels in a single request. Simply specify a list of channel IDs, and the API will return the details of each channel.

This request supports batch processing, allowing you to retrieve up to 1,000 channels in a single request.

Price

The cost of this request is based on the number of channels you request. The base cost of request is $0.00003, and each set of 50 channels costs $0.00001.

For example:

  • 1 channel requires 1 quota
  • 50 channels requires 1 quota
  • 75 channels requires 2 quotas
  • 100 channels requires 2 quotas
  • 101 channels requires 3 quotas
  • 1000 channels requires 20 quotas.

Authorizations

Authorization
string
headerrequired

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

Query Parameters

hl
enum<string>

The language code (e.g., "en-US", "es") to retrieve localized data in. If not specified, the default language of the channel is used.

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,
zu
fields
string

A comma-separated list of fields to include in the response. If not provided, all fields will be returned.

Body

application/json
ids
string[]
required

An array of channel IDs to retrieve data for. Each ID should be a valid 24-character channel ID. Minimum 1, maximum 1000 IDs.

includeLocalizations
boolean
default: false

Whether to include localized data for the channel. If true, localized fields will be returned in the specified language (hl parameter). Default is false.

Response

200 - application/json
totalResults
number
required

The total number of channels returned

data
object[]
required