{ "openapi": "3.0.1", "info": { "title": "YouTube API | YouTube comments video search channel videos", "description": "SocialDataX read-only YouTube API for YouTube comments, video search, video details, comment replies, channel profiles, and YouTube channel videos. Results export to Apify Dataset, CSV, Excel, JSON, or API workflows. Includes channel search and keyword suggestions.", "version": "0.1", "x-build-id": "XrFwfno1WXWBOCVF4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/socialdatax~socialdatax-youtube-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-socialdatax-socialdatax-youtube-data-api", "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/socialdatax~socialdatax-youtube-data-api/runs": { "post": { "operationId": "runs-sync-socialdatax-socialdatax-youtube-data-api", "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/socialdatax~socialdatax-youtube-data-api/run-sync": { "post": { "operationId": "run-sync-socialdatax-socialdatax-youtube-data-api", "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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "search_videos", "get_video_detail", "get_video_comments", "get_video_comment_replies", "get_channel_info", "list_channel_videos", "search_channels", "search_suggestions" ], "type": "string", "description": "Choose the YouTube API operation to run.", "default": "search_videos" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword for YouTube content, channels and search suggestions.", "default": "camping" }, "page_token": { "title": "Page Token", "type": "string", "description": "Opaque pagination token returned by the previous page. Leave empty for the first page." }, "sort_type": { "title": "Sort Type", "type": "string", "description": "Sort option. YouTube video search supports general, time_descending, view_count_descending, rating. YouTube comments support hot, time_descending." }, "video_type": { "title": "Video Type", "type": "string", "description": "Video type filter. YouTube video search supports all, video, movie. YouTube channel videos support video, short." }, "publish_time_range": { "title": "Publish Time Range", "enum": [ "all", "last_hour", "today", "this_week", "this_month", "this_year" ], "type": "string", "description": "Publish time range filter.", "default": "all" }, "duration_range": { "title": "Duration Range", "enum": [ "all", "under_4_min", "between_4_and_20_min", "over_20_min" ], "type": "string", "description": "Duration range filter.", "default": "all" }, "video_url": { "title": "Video URL", "type": "string", "description": "YouTube video URL." }, "reply_token": { "title": "Reply Token", "type": "string", "description": "YouTube comment reply token." }, "channel_url": { "title": "Channel URL", "type": "string", "description": "YouTube channel URL." }, "max_items": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of Dataset rows for list operations. Larger values may make multiple SocialDataX API requests.", "default": 50 }, "auto_paginate": { "title": "Auto paginate", "type": "boolean", "description": "When enabled, the Actor keeps requesting next pages until max_items is reached or no next page exists.", "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 }, "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 } } } } } } } } } }