Read as Markdown · Use with an AI agent
Endpoint
/v1/youtube/profile/fulllive · proven5 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
channelId | no | Channel id. One of channelId, handle or url is required | UC_x5XG1OV2P6uZZ5FSM9Ttw |
handle | no | Channel @handle | @googledevelopers |
url | no | Any channel URL | https://www.youtube.com/@googledevelopers |
posts | no | Recent uploads to sample for analytics, 1-50 (default 10) | 10 |
cursor | no | Opaque page token to continue the recent-uploads listing | CAUQAA |
include | no | Comma list: videos and/or analytics (default both) | videos,analytics |
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 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/youtube/profile/full" \ -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/profile/full",
{ 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/profile/full",
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/profile/full",
"data": {
"channel": {
"id": "UC_example",
"name": "Example Channel"
},
"recent_videos": [
{
"id": "abcdefghijk",
"title": "A quieter desk setup",
"published_at": "2026-09-01T12:00:00Z",
"channel": {
"id": "UC_example",
"name": "Example Channel"
},
"duration_seconds": 482,
"views": 12600,
"likes": 640,
"comments_count": 38
}
],
"recent_count": 1,
"cursor": null,
"recent_videos_pagination": {
"returned": 1,
"total": null,
"has_more": false
}
},
"credits_used": 5,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example uses fictional values 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.
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 |
|---|---|---|
channel | object | Nested response fields; optional unless explicitly documented. |
channel.id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
channel.handle | string | null | Public account username. |
channel.name | string | null | Display name. |
channel.url | string | null | Original source URL when supplied. |
channel.description | string | null | Channel description. |
channel.country | string | null | Channel country when supplied. |
channel.subscribers | number | null | Public subscribers; can be rounded reported by the source; null or absent is unknown, not zero. |
channel.subscribers_hidden | boolean | null | Whether the source marks subscriber totals hidden. |
channel.views | number | null | Channel views reported by the source; null or absent is unknown, not zero. |
channel.video_count | number | null | Videos reported by the source; null or absent is unknown, not zero. |
channel.uploads_playlist_id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
recent_videos | array | Nested response fields; optional unless explicitly documented. |
recent_videos[].id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
recent_videos[].url | string | null | Original source URL when supplied. |
recent_videos[].title | string | null | Video title. |
recent_videos[].description | string | null | Video description. |
recent_videos[].published_at | string | null | Source publication time, normalized to an ISO date-time when available. |
recent_videos[].duration_seconds | number | null | Duration in seconds. |
recent_videos[].channel | object | Nested response fields; optional unless explicitly documented. |
recent_videos[].channel.id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
recent_videos[].channel.name | string | null | Channel display name. |
recent_videos[].channel.url | string | null | Original source URL when supplied. |
recent_videos[].views | number | null | Views reported by the source; null or absent is unknown, not zero. |
recent_videos[].likes | number | null | Likes reported by the source; null or absent is unknown, not zero. |
recent_videos[].comments_count | number | null | Comments reported by the source; null or absent is unknown, not zero. |
recent_count | number | null | Returned uploads reported by the source; null or absent is unknown, not zero. |
cursor | string | null | Uploads continuation token. |
recent_videos_pagination | object | Nested response fields; optional unless explicitly documented. |
recent_videos_pagination.returned | number | null | Returned uploads reported by the source; null or absent is unknown, not zero. |
recent_videos_pagination.total | number | null | Reported uploads reported by the source; null or absent is unknown, not zero. |
recent_videos_pagination.has_more | boolean | null | Whether another source page is reported. |
sources | array | Nested response fields; optional unless explicitly documented. |
sources[].source | string | null | Component name. |
sources[].ok | boolean | null | Component request success. |
sources[].complete | boolean | null | All requested detail records returned. |
sources[].missing_ids | array | Nested response fields; optional unless explicitly documented. |
analytics | object | null | Nested response fields; optional unless explicitly documented. |
analytics.sampled_videos | number | null | Videos with numeric view counts reported by the source; null or absent is unknown, not zero. |
analytics.metric_samples | object | Nested response fields; optional unless explicitly documented. |
analytics.metric_samples.views | number | null | Videos with views reported by the source; null or absent is unknown, not zero. |
analytics.metric_samples.likes | number | null | View-sample videos with likes reported by the source; null or absent is unknown, not zero. |
analytics.metric_samples.comments | number | null | View-sample videos with comments reported by the source; null or absent is unknown, not zero. |
analytics.metric_samples.engagement | number | null | Videos with all three counters reported by the source; null or absent is unknown, not zero. |
analytics.avg_views | number | null | Rounded average views over the view sample. |
analytics.avg_likes | number | null | Rounded average likes over available values in the view sample. |
analytics.avg_comments | number | null | Rounded average comments over available values in the view sample. |
analytics.engagement_rate | number | null | (sum likes + sum comments) / sum views for complete triples, rounded to six decimals. A ratio, not percent; null with zero summed views. |
analytics.most_viewed_video_id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
Analytics are optional and refer only to the returned page. See /docs/computed-fields for formulas and missing-input rules. Missing video details can leave playlist-only rows in recent_videos.
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