{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper", "description": "YouTube Scraper SD - YouTube Scraper is a powerful tool that extracts video titles, channels, views, durations, upload times and URLs from YouTube search results by keyword, filters, channel, playlist or video URL - YouTube search and video data extractor for research.", "version": "0.0", "x-build-id": "zTinLkoAJoOPDInMB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~youtube-comment-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-youtube-comment-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/neuro-scraper~youtube-comment-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-youtube-comment-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/neuro-scraper~youtube-comment-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-youtube-comment-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "What you would type into the YouTube search box, one term per line. Example: lofi music", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. YouTube video URLs (one detailed row each), channel URLs (the channel's videos), playlist URLs (the playlist's videos) or search result URLs (youtube.com/results?search_query=...).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max results per search or URL", "minimum": 1, "type": "integer", "description": "How many videos to collect for each search term and each channel, playlist or search URL. The Actor pages through the results until it has this many or YouTube has no more.", "default": 20 }, "maxItems": { "title": "Max videos in total", "minimum": 1, "type": "integer", "description": "Optional cap on the whole run. Leave empty for no total cap." }, "searchType": { "title": "Result type", "enum": [ "videos", "shorts", "all" ], "type": "string", "description": "Search terms only. 'Videos' applies YouTube's Videos filter, 'Shorts' its Shorts filter, 'Videos and Shorts' uses no type filter (YouTube mixes videos and Shorts shelves).", "default": "videos" }, "uploadDate": { "title": "Upload date", "enum": [ "any", "today", "week", "month", "year" ], "type": "string", "description": "Search terms only. YouTube's upload-date filter.", "default": "any" }, "duration": { "title": "Duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Search terms only. YouTube's duration filter: under 3 minutes, 3 - 20 minutes, over 20 minutes.", "default": "any" }, "features": { "title": "Features", "type": "array", "description": "Search terms only. Optional YouTube feature filters (Live, 4K, HD, Subtitles/CC, Creative Commons ...).", "items": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creativeCommons", "360", "vr180", "3d", "hdr", "location", "purchased" ], "enumTitles": [ "Live", "4K", "HD", "Subtitles/CC", "Creative Commons", "360°", "VR180", "3D", "HDR", "Location", "Purchased" ] } }, "sortingOrder": { "title": "Prioritize", "enum": [ "relevance", "popularity" ], "type": "string", "description": "Search terms only. YouTube's own order options: Relevance (default) or Popularity.", "default": "relevance" }, "scrapeVideoDetails": { "title": "Add full video details", "type": "boolean", "description": "Open every video's page and add likes, exact views, full description, publish date, category, tags, hashtags, chapters and subscriber count. One extra page per video - slower.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy, RESIDENTIAL group in the United States, is used by default. You can pick another country or group; the run then follows YouTube's answers for that location.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }