{ "openapi": "3.0.1", "info": { "title": "YouTube Trending Videos by Country and Category", "description": "Get YouTube's most-popular (trending) videos for any country and category through the official YouTube Data API, with views, likes, comments, duration and channel. Bring your own free API key. Pay per ranked video.", "version": "1.0", "x-build-id": "63oR9dKN9w1xYAEVS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~youtube-trending-videos-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-youtube-trending-videos-lookup", "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/accountable_eel~youtube-trending-videos-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-youtube-trending-videos-lookup", "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/accountable_eel~youtube-trending-videos-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-youtube-trending-videos-lookup", "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": { "regionCodes": { "title": "Country codes", "type": "array", "description": "One two-letter country code per line (ISO 3166-1, for example US, GB, DE, JP). Each country gets its own chart. You need your own free YouTube Data API key (field below) to get rows. Accepted formats: US, GB, DE. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "youtubeApiKey": { "title": "Your YouTube Data API v3 key", "type": "string", "description": "Optional but needed for rows. Get a free key in about 10 minutes: create a project in Google Cloud Console, enable YouTube Data API v3, then Credentials > Create credentials > API key. Free quota is 10,000 units a day and one chart page (50 videos) costs 1 unit. Without a key every country comes back as a NEEDS_KEY row that is never charged. The key is sent only to googleapis.com, in a request header, and is never stored, logged or written to the dataset." }, "categoryId": { "title": "Category", "enum": [ "all", "1", "2", "10", "15", "17", "19", "20", "22", "23", "24", "25", "26", "27", "28" ], "type": "string", "description": "Which chart to read. 'All categories' is YouTube's overall most-popular chart for the country. Some countries have no chart for some categories; those come back as a free NOT_FOUND row.", "default": "all" }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "regionCode", "categoryFilter", "chartSummary", "videoCount", "sourceUrl", "videos", "rank", "videoId", "title", "channelTitle", "channelId", "publishedAt", "categoryId", "categoryName", "viewCount", "likeCount", "commentCount", "duration", "durationSeconds", "description", "thumbnailUrl", "defaultLanguage", "url" ], "enumTitles": [ "Country", "Category filter", "Chart run", "Videos returned", "Source request", "All videos (full list)", "Rank", "Video id", "Title", "Channel", "Channel id", "Published on", "Category id", "Category", "Views", "Likes", "Comments", "Duration (ISO 8601)", "Duration (seconds)", "Description (first 300 characters)", "Thumbnail", "Language", "Video page" ] }, "default": [ "regionCode", "categoryFilter", "chartSummary", "videoCount", "sourceUrl", "videos", "rank", "videoId", "title", "channelTitle", "channelId", "publishedAt", "categoryId", "categoryName", "viewCount", "likeCount", "commentCount", "duration", "durationSeconds", "description", "thumbnailUrl", "defaultLanguage", "url" ] }, "expandRows": { "title": "One row per video (recommended) — turn off for one row per country chart instead", "type": "boolean", "description": "When on, each video found gets its own row instead of being grouped under its country chart. You're still only charged once per country chart, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 2 } } }, "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 } } } } } } } } } }