{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper by Keyword Search (Videos & Shorts)", "description": "Search YouTube by keyword and scrape videos and Shorts. Get titles, channels, views, duration, thumbnails, and more.", "version": "0.0", "x-build-id": "twRCHevJkecTcEpgh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lurkapi~youtube-keyword-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lurkapi-youtube-keyword-search-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/lurkapi~youtube-keyword-search-scraper/runs": { "post": { "operationId": "runs-sync-lurkapi-youtube-keyword-search-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/lurkapi~youtube-keyword-search-scraper/run-sync": { "post": { "operationId": "run-sync-lurkapi-youtube-keyword-search-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Search Keywords", "maxItems": 50, "type": "array", "description": "Keywords to search for on YouTube. Each keyword runs a separate search. Examples: 'python tutorial', 'how to cook pasta', 'best laptops 2026'.", "items": { "type": "string" } }, "maxVideosPerKeyword": { "title": "Max Videos Per Keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of videos to scrape per keyword. Default 50, max 500.", "default": 50 }, "contentType": { "title": "Content Type", "enum": [ "all", "videos", "shorts" ], "type": "string", "description": "Filter by content type: all videos and Shorts, only regular videos, or only Shorts.", "default": "all" }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "upload_date", "view_count", "rating" ], "type": "string", "description": "How YouTube sorts search results. Relevance is the default YouTube ranking. Upload date shows newest first. View count shows most viewed first.", "default": "relevance" }, "uploadDate": { "title": "Upload Date", "enum": [ "all", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only show videos uploaded within a certain time frame. This is YouTube's built-in search filter.", "default": "all" }, "videoDuration": { "title": "Video Duration", "enum": [ "all", "short", "medium", "long" ], "type": "string", "description": "Filter by video length. Short is under 4 minutes, medium is 4 to 20 minutes, long is over 20 minutes.", "default": "all" }, "titleFilter": { "title": "Title Filter", "type": "string", "description": "Only keep videos whose title contains a specific keyword. You can type multiple keywords separated by commas (e.g. 'beginner, tutorial'). Leave empty to keep all videos. This filter is free." }, "publishedWithinDays": { "title": "Published Within (Days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only include videos published within the last N days. More precise than the Upload Date search filter above. Leave empty or 0 to include all videos." }, "includeVideoStats": { "title": "Include Video Stats", "type": "boolean", "description": "Fetch stats for each video: likes, comment count, full description, category, tags, and exact publish date. This is a paid add-on ($0.25 per 1,000 videos) and makes the scraper slower since it fetches each video individually.", "default": false }, "detectLanguage": { "title": "Detect Language", "type": "boolean", "description": "Detect the spoken language of each video using YouTube's caption data. Adds a detectedLanguage field (e.g. 'en', 'ko', 'es'). Only charged when language is successfully detected ($0.10 per 1,000 videos).", "default": false }, "includeChannelAnalytics": { "title": "Include Channel Analytics", "type": "boolean", "description": "Fetch analytics for each video's channel: subscriber count, total videos, total views, channel description, country, and join date. Results are cached per channel so you only pay once per unique channel. This is a paid add-on ($0.25 per 1,000 videos).", "default": false }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of keywords to process in parallel (max 10). Higher values are faster but use more memory.", "default": 3 }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies for accessing YouTube.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } }, "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 } } } } } } } } } }