{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper", "description": "Get YouTube video titles, views, likes, comment counts, upload dates, durations, descriptions and channel stats from search terms, channel URLs (videos, Shorts, live) or video URLs. Export as JSON, CSV or Excel.", "version": "1.0", "x-build-id": "am4maSfQ5yhSWLZYM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammad_noman_riaz~youtube-super-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammad_noman_riaz-youtube-super-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/muhammad_noman_riaz~youtube-super-scraper/runs": { "post": { "operationId": "runs-sync-muhammad_noman_riaz-youtube-super-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/muhammad_noman_riaz~youtube-super-scraper/run-sync": { "post": { "operationId": "run-sync-muhammad_noman_riaz-youtube-super-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchQueries": { "title": "Search terms", "type": "array", "description": "Keywords to search on YouTube, one per line. Each term returns up to Maximum videos results.", "items": { "type": "string" } }, "startUrls": { "title": "Direct URLs", "type": "array", "description": "YouTube video URLs (youtube.com/watch?v=... or youtu.be/...) and channel URLs (youtube.com/@handle, /channel/ID, /c/name or /user/name). Other URL types are skipped.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Maximum videos", "minimum": 0, "type": "integer", "description": "How many videos to return for each search term and for each channel (from its Videos tab). Set 0 to skip regular videos.", "default": 10 }, "maxResultsShorts": { "title": "Maximum Shorts per channel", "minimum": 0, "type": "integer", "description": "How many Shorts to return from each channel URL. Only the first page of the Shorts tab is read (about 40 items). Set 0 to skip.", "default": 0 }, "maxResultStreams": { "title": "Maximum live streams per channel", "minimum": 0, "type": "integer", "description": "How many past, live or upcoming streams to return from each channel URL (its Live tab). Set 0 to skip.", "default": 0 }, "dateFilter": { "title": "Date filter", "enum": [ "hour", "today", "week", "month", "year" ], "type": "string", "description": "Search only: keep videos uploaded within this period." }, "videoType": { "title": "Video type filter", "enum": [ "video", "movie" ], "type": "string", "description": "Search only: restrict results to regular videos or movies." }, "lengthFilter": { "title": "Length filter", "enum": [ "under4", "between420", "plus20" ], "type": "string", "description": "Search only: under 4 minutes, 4 to 20 minutes, or over 20 minutes." }, "isHD": { "title": "HD", "type": "boolean", "description": "Search only: applies the HD filter. Filters can be combined." }, "hasSubtitles": { "title": "Subtitles/CC", "type": "boolean", "description": "Search only: applies the Subtitles/CC filter. Filters can be combined." }, "hasCC": { "title": "Creative Commons", "type": "boolean", "description": "Search only: applies the Creative Commons filter. Filters can be combined." }, "is3D": { "title": "3D", "type": "boolean", "description": "Search only: applies the 3D filter. Filters can be combined." }, "isLive": { "title": "Live", "type": "boolean", "description": "Search only: applies the Live filter. Filters can be combined." }, "isBought": { "title": "Purchased", "type": "boolean", "description": "Search only: applies the Purchased filter. Filters can be combined." }, "is4K": { "title": "4K", "type": "boolean", "description": "Search only: applies the 4K filter. Filters can be combined." }, "is360": { "title": "360 degrees", "type": "boolean", "description": "Search only: applies the 360 degrees filter. Filters can be combined." }, "hasLocation": { "title": "Location", "type": "boolean", "description": "Search only: applies the Location filter. Filters can be combined." }, "isHDR": { "title": "HDR", "type": "boolean", "description": "Search only: applies the HDR filter. Filters can be combined." }, "isVR180": { "title": "VR180", "type": "boolean", "description": "Search only: applies the VR180 filter. Filters can be combined." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy for requests to YouTube. Apify Proxy is recommended on the platform; YouTube may block datacenter IPs.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }