API reference
YouTube Channels (Batch) API
Batch channel lookup — one normalized record per id; unknown/terminated ids are reported in `missing`.
Endpoint
/v1/youtube/channelslive · proven2 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
ids | yes | Comma-separated (or JSON array of) channel ids; up to 250, chunked 50 per upstream call | UC_x5XG1OV2P6uZZ5FSM9Ttw,UCrDkAvwZum-UTjHmzDI2iIw |
hl | no | BCP-47 language for localized snippet text | en |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/youtube/channels?ids=UC_x5XG1OV2P6uZZ5FSM9Ttw%2CUCrDkAvwZum-UTjHmzDI2iIw" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/youtube/channels?ids=UC_x5XG1OV2P6uZZ5FSM9Ttw%2CUCrDkAvwZum-UTjHmzDI2iIw",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/youtube/channels?ids=UC_x5XG1OV2P6uZZ5FSM9Ttw%2CUCrDkAvwZum-UTjHmzDI2iIw",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "youtube",
"endpoint": "/v1/youtube/channels",
"data": {
"_warnings": [
"example"
],
"count": 0,
"items": [
{
"_warnings": [
"example"
],
"avatar_url": "https://example.com/example",
"banner_url": "https://example.com/example",
"country": "example",
"description": "example",
"handle": "example",
"id": "example",
"keywords": "example",
"name": "example",
"published_at": "2026-09-01T12:00:00Z",
"subscribers": 0,
"subscribers_hidden": false,
"thumbnails": {
"default": {},
"high": {},
"medium": {}
},
"uploads_playlist_id": "example",
"url": "https://example.com/example",
"video_count": 0,
"views": 0
}
],
"missing": [],
"requested": 0
},
"credits_used": 2,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
_warnings | array | null | Optional warnings supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[]._warnings | array | null | Optional warnings supplied by this operation. Null means unknown. |
items[].avatar_url | string | null | Optional avatar url supplied by this operation. Null means unknown. |
items[].banner_url | string | null | Optional banner url supplied by this operation. Null means unknown. |
items[].country | string | null | Optional country supplied by this operation. Null means unknown. |
items[].description | string | null | Source description; null or absent means not supplied. |
items[].handle | string | null | Optional handle supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].keywords | string | null | Optional keywords supplied by this operation. Null means unknown. |
items[].name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].published_at | string | null | Source publication time when available. |
items[].subscribers | number | null | Optional subscribers supplied by this operation. Null means unknown. |
items[].subscribers_hidden | boolean | null | Optional subscribers hidden supplied by this operation. Null means unknown. |
items[].thumbnails | object | null | Optional thumbnails supplied by this operation. Null means unknown. |
items[].thumbnails.default | object | null | Optional default supplied by this operation. Null means unknown. |
items[].thumbnails.high | object | null | Optional high supplied by this operation. Null means unknown. |
items[].thumbnails.medium | object | null | Optional medium supplied by this operation. Null means unknown. |
items[].uploads_playlist_id | string | null | Optional uploads playlist id supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
items[].video_count | number | null | Optional video count supplied by this operation. Null means unknown. |
items[].views | number | null | Optional views supplied by this operation. Null means unknown. |
missing | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
requested | number | null | Optional requested supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference