# YouTube Search Data Scraper (`thescrappa/youtube-api-search-data`) Actor Search YouTube by query and filter results by type, sort order, duration, upload date, content type, features, limit, and continuation token. - **URL**: https://apify.com/thescrappa/youtube-api-search-data.md - **Developed by:** [Scrappa](https://apify.com/thescrappa) (community) - **Categories:** Social media, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.20 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## YouTube API Search Data Search YouTube for videos, channels, playlists, movies, live streams, and filtered result sets. The Actor returns one dataset item per YouTube search result, so you can export results to JSON, CSV, Excel, or connect them to downstream Apify integrations. ### What You Can Get - YouTube video, channel, playlist, movie, and mixed search results - Titles, descriptions, thumbnails, result IDs, durations, view counts, and publish times - Channel metadata including channel ID, name, URL, thumbnail, and verification status - Badges such as `CC`, `New`, `4K`, or other labels returned by YouTube - Live, Shorts, and Premium flags when available - Chapter or extra result metadata when YouTube returns expandable result details ### Input | Field | Type | Required | Description | |-------|------|----------|-------------| | `q` | string | Yes | YouTube search query. | | `sort` | array | No | Sort order. One of `relevance`, `rating`, `upload_date`, or `view_count`. Defaults to `relevance`. | | `duration` | array | No | Video duration filter. One of `short`, `medium`, or `long`. | | `upload_date` | array | No | Upload date filter. One of `hour`, `today`, `week`, `month`, or `year`. The actor maps this to Scrappa `publishedAfter`. | | `limit` | integer | No | Maximum results to return, from `1` to `20`. | | `continuation` | string | No | Continuation token for the next page of results. | | `type` | array | No | Result type. One of `all`, `video`, `channel`, `playlist`, or `movie`. | Apify select fields are arrays in JSON input. Use a single selected value in each array, for example `"type": ["video"]`. ### Example Inputs #### Recent Tutorial Videos ```json { "q": "javascript tutorial", "type": ["video"], "sort": ["upload_date"], "upload_date": ["week"], "duration": ["medium"], "limit": 20 } ```` #### High-View Product Reviews ```json { "q": "iphone 16 pro review", "type": ["video"], "sort": ["view_count"], "limit": 20 } ``` #### AI News Videos ```json { "q": "ai news live", "type": ["video"], "limit": 20 } ``` #### Channels Matching a Query ```json { "q": "web development", "type": ["channel"], "sort": ["relevance"], "limit": 20 } ``` #### Continue to the Next Page ```json { "q": "javascript tutorial", "type": ["video"], "sort": ["relevance"], "limit": 20, "continuation": "PASTE_CONTINUATION_TOKEN_FROM_PREVIOUS_RUN" } ``` When the API returns a next-page token, the Actor logs it as `Continuation token available for next page: ...`. ### Output Each YouTube search result is saved as one dataset item. Fields vary by result type, but video results commonly include: ```json { "type": "Video", "id": "W6NZfCO5SIk", "title": "JavaScript Course for Beginners - Your First Step to Web Development", "description": "Learn JavaScript basics with this quick, beginner-friendly course...", "thumbnail": "https://i.ytimg.com/vi/W6NZfCO5SIk/hq720.jpg", "duration": "48:17", "viewCount": "14,962,240 views", "publishedTime": "8 years ago", "channel": { "id": "UCWv7vMbMWH4-V0ZXdmDpPBA", "name": "Programming with Mosh", "thumbnail": "https://yt3.ggpht.com/...", "verified": true, "isVerifiedArtist": false, "url": "https://www.youtube.com/@programmingwithmosh" }, "badges": ["CC"], "isLive": false, "isShort": false, "isPremium": false, "expandableMetadata": null } ``` ### Dataset Columns The default dataset view highlights the most useful columns for scanning and exporting search results: | Column | Description | |--------|-------------| | `type` | Result type, such as `Video`, `Channel`, or `Playlist`. | | `id` | YouTube result ID, such as a video ID or channel ID. | | `title` | Result title. | | `channel.name` | Channel name for video results. | | `channel.url` | Channel URL when provided by YouTube. | | `duration` | Video duration when available. | | `viewCount` | Display view count text returned by YouTube. | | `publishedTime` | Relative publish time returned by YouTube. | | `thumbnail` | Result thumbnail image URL. | | `badges` | Search result badges, labels, or availability markers. | | `isLive` | Whether the result is live. | | `isShort` | Whether the result is a Short. | | `isPremium` | Whether the result is marked as Premium. | ### Pricing $0.30 per 1,000 results. No additional API keys required. ### Support For issues or questions, contact us through Apify. # Actor input Schema ## `q` (type: `string`): Search query ## `sort` (type: `array`): Sort by: relevance, rating, upload\_date, view\_count ## `duration` (type: `array`): Video duration: short, medium, long ## `upload_date` (type: `array`): Upload date filter. Mapped to Scrappa publishedAfter. ## `limit` (type: `integer`): Maximum number of results to return ## `continuation` (type: `string`): Pagination token for next page ## `type` (type: `array`): Filter by result type ## Actor input object example ```json { "q": "Javascript tutorial", "sort": [ "relevance" ], "duration": [ "short" ], "upload_date": [ "hour" ], "limit": 10, "type": [ "all" ] } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "q": "Javascript tutorial", "sort": [ "relevance" ], "duration": [ "short" ], "upload_date": [ "hour" ], "type": [ "all" ] }; // Run the Actor and wait for it to finish const run = await client.actor("thescrappa/youtube-api-search-data").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "q": "Javascript tutorial", "sort": ["relevance"], "duration": ["short"], "upload_date": ["hour"], "type": ["all"], } # Run the Actor and wait for it to finish run = client.actor("thescrappa/youtube-api-search-data").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "q": "Javascript tutorial", "sort": [ "relevance" ], "duration": [ "short" ], "upload_date": [ "hour" ], "type": [ "all" ] }' | apify call thescrappa/youtube-api-search-data --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=thescrappa/youtube-api-search-data", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "YouTube Search Data Scraper", "description": "Search YouTube by query and filter results by type, sort order, duration, upload date, content type, features, limit, and continuation token.", "version": "0.0", "x-build-id": "a5bwhIZFskvlb5Zt0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrappa~youtube-api-search-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrappa-youtube-api-search-data", "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/thescrappa~youtube-api-search-data/runs": { "post": { "operationId": "runs-sync-thescrappa-youtube-api-search-data", "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/thescrappa~youtube-api-search-data/run-sync": { "post": { "operationId": "run-sync-thescrappa-youtube-api-search-data", "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": [ "q" ], "properties": { "q": { "title": "Query", "type": "string", "description": "Search query" }, "sort": { "title": "Sort", "type": "array", "description": "Sort by: relevance, rating, upload_date, view_count", "items": { "type": "string", "enum": [ "relevance", "rating", "upload_date", "view_count" ] } }, "duration": { "title": "Duration", "type": "array", "description": "Video duration: short, medium, long", "items": { "type": "string", "enum": [ "short", "medium", "long" ] } }, "upload_date": { "title": "Upload date", "type": "array", "description": "Upload date filter. Mapped to Scrappa publishedAfter.", "items": { "type": "string", "enum": [ "hour", "today", "week", "month", "year" ] } }, "limit": { "title": "Limit", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of results to return", "default": 10 }, "continuation": { "title": "Continuation", "type": "string", "description": "Pagination token for next page" }, "type": { "title": "Type", "type": "array", "description": "Filter by result type", "items": { "type": "string", "enum": [ "all", "video", "channel", "playlist", "movie" ] } } } }, "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 } } } } } } } } } } ```