{ "openapi": "3.0.1", "info": { "title": "YouTube Video Scraper", "description": "Scrape YouTube videos. Search by keywords or trending feed. Filter long/short videos, sort by date or views, set language and region.", "version": "0.2", "x-build-id": "IaaxH413tdUOXURPJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getdataforu~youtube-video-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getdataforu-youtube-video-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/getdataforu~youtube-video-scraper/runs": { "post": { "operationId": "runs-sync-getdataforu-youtube-video-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/getdataforu~youtube-video-scraper/run-sync": { "post": { "operationId": "run-sync-getdataforu-youtube-video-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": [ "maxResults" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "List of search keywords. Required when scrape mode is 'search'. maxResults is split evenly across all keywords (e.g. 100 videos and 8 keywords → ~12–13 videos per keyword).", "default": [ "viral shorts", "trending" ], "items": { "type": "string" } }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of videos to return per run.", "default": 100 }, "maxSeenIds": { "title": "Max Seen IDs", "minimum": 500, "maximum": 50000, "type": "integer", "description": "Maximum video IDs stored in state to prevent duplicates across runs.", "default": 5000 }, "scrapeMode": { "title": "Scrape Mode", "enum": [ "search", "trending" ], "type": "string", "description": "How to discover videos: keyword search or YouTube trending feed.", "default": "search" }, "videoType": { "title": "Video Type", "enum": [ "long", "short", "all" ], "type": "string", "description": "Filter by video length: long (>60s), short (<=60s), or all.", "default": "long" }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "upload_date", "view_count", "rating", "oldest" ], "type": "string", "description": "Sort order. upload_date = newest first, oldest = reverse upload order, view_count = most viewed.", "default": "relevance" }, "uploadDate": { "title": "Upload Date", "enum": [ "all", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only include videos uploaded within this time window (search mode).", "default": "all" }, "language": { "title": "YouTube Language", "enum": [ "vi", "en", "ja", "ko", "th", "zh", "de", "fr", "es", "pt" ], "type": "string", "description": "Language/locale for YouTube Innertube client (affects search results).", "default": "vi" }, "region": { "title": "Region", "type": "string", "description": "Country/region code for YouTube results (e.g. VN, US, JP).", "default": "VN" }, "contentLanguage": { "title": "Content Language Filter", "enum": [ "all", "vi", "en", "ja", "ko", "th", "zh" ], "type": "string", "description": "Filter results by title/channel language. Use 'all' to keep every result. If keywords are English but this is 'vi', almost all videos will be removed.", "default": "all" }, "features": { "title": "Features", "type": "array", "description": "YouTube search feature filters (search mode): hd, subtitles, creative_commons, 3d, live, 4k, 360, location, hdr, vr180.", "default": [], "items": { "type": "string" } }, "deduplicate": { "title": "Deduplicate Across Runs", "type": "boolean", "description": "Skip videos already scraped in previous runs (uses persisted state).", "default": true } } }, "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 } } } } } } } } } }