~ / docs

YouTube Scraper API docs

One REST API for YouTube data. Authenticate with a key, call an endpoint, get structured JSON back. Every request is metered in credits and billed only on success.

base url

Base URL

All endpoints live under a single base URL. Send standard HTTP GET requests; responses are JSON.

base url
https://api.youtubescraperapi.com/api/v1
authentication

Authentication

Pass your API key as the api_key query parameter on every request. Create and manage keys in your dashboard. Keep keys server-side; do not expose them in client-side code.

auth
https://api.youtubescraperapi.com/api/v1/<endpoint>?...&api_key=YOUR_API_KEY
quickstart

Your first request

cURL
curl "https://api.youtubescraperapi.com/api/v1/youtube/video?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ&api_key=YOUR_API_KEY"
endpoints

YouTube endpoints

Each endpoint returns a stable JSON shape. Follow a link for its full parameters and response fields.

EndpointWhat it returns
Transcript API & Generatoryoutube transcript
Search Resultsscrape youtube ad results
Commentyoutube comment scraper
Channelyoutube channel scraper
Videoyoutube video scraper
Playlistscrape youtube playlist results
Caption & Subtitleyoutube caption scraper
Email & Leadyoutube email scraper
Shortsyoutube shorts scraper
Free YouTubefree youtube scraper
credits

Credits and limits

Usage is metered in credits: each successful YouTube request costs 5 credits. The free plan includes 1,000 scrapes. Failed requests are retried automatically and never charged, and your live balance, plan limit, and usage history are in the dashboard. See pricing for plan allowances and pay-as-you-go.

responses

Response and error codes

StatusMeaning
200Success. The response body is the parsed JSON for your request.
401Missing or invalid api_key. Check the key in your dashboard.
402Out of credits or plan limit reached. Top up or upgrade in the dashboard.
404The requested resource does not exist (for example a deleted or private item).
429Rate limit exceeded for your plan. Slow the request rate or upgrade.
5xxA temporary upstream issue. The request is retried for you; persistent errors are not charged.
Get an API key
1,000 free scrapes, no credit card.
Get a free API key