{ "openapi": "3.0.1", "info": { "title": "YouTube Hashtag Video & Shorts Ranking Scraper", "description": "Look up one or more YouTube hashtags and get the videos and Shorts currently ranked under them, in order, with view count, channel, duration and the hashtag's own total video and channel counts.", "version": "1.0", "x-build-id": "jVtydLgaRgAoNQmFS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~youtube-hashtag-video-and-shorts-ranking-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-youtube-hashtag-video-and-shorts-ranking-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/dataspryva~youtube-hashtag-video-and-shorts-ranking-scraper/runs": { "post": { "operationId": "runs-sync-dataspryva-youtube-hashtag-video-and-shorts-ranking-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/dataspryva~youtube-hashtag-video-and-shorts-ranking-scraper/run-sync": { "post": { "operationId": "run-sync-dataspryva-youtube-hashtag-video-and-shorts-ranking-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": [ "hashtags" ], "properties": { "hashtags": { "title": "Hashtags", "minItems": 1, "type": "array", "description": "Hashtags to scrape. Accepts a bare tag, a #tag, or a full youtube.com/hashtag/ URL. Up to 200 unique tags per run.", "items": { "type": "string" } }, "maxResultsPerHashtag": { "title": "Max Results Per Hashtag", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum records to return per hashtag after sorting and filters. YouTube's hashtag feed is a ranked sample, so large values may return fewer rows.", "default": 50 }, "contentType": { "title": "Content Type", "enum": [ "all", "videos", "shorts" ], "type": "string", "description": "Which cards to return: regular videos, Shorts, or both.", "default": "all" }, "market": { "title": "Market / Region", "enum": [ "US", "GB", "CA", "AU", "DE", "FR", "JP", "KR", "BR", "IN", "MX", "IT", "ES", "NL", "PL", "RU", "SE", "NO", "DK", "FI", "ZA", "SG", "HK", "TW", "ID", "MY", "TH", "PH", "AR", "CO", "CL" ], "type": "string", "description": "Country/region used for the hashtag feed. It changes which videos rank and the default language.", "default": "US" }, "language": { "title": "Language", "enum": [ "auto", "en", "de", "fr", "ja", "ko", "pt", "hi", "es", "it", "nl", "pl", "ru", "sv", "no", "da", "fi", "zh-Hant", "id", "ms", "th", "ar", "tr", "vi", "uk", "cs", "ro", "hu", "el", "he" ], "type": "string", "description": "Language used for YouTube labels, counts and dates. Auto follows the selected market.", "default": "auto" }, "includeVideoDetails": { "title": "Include Video Details", "type": "boolean", "description": "Fetch each video's detail data to fill exact views, likes, comments, subscriber counts, publish date, description, keywords, category and Shorts channel metadata. Slower but more complete.", "default": true }, "sortBy": { "title": "Sort By", "enum": [ "default", "viewCount", "durationSeconds", "publishedAt" ], "type": "string", "description": "Order the collected results within each hashtag. Default keeps YouTube's first-seen feed order.", "default": "default" }, "minViewCount": { "title": "Minimum View Count", "minimum": 0, "maximum": 2000000000, "type": "integer", "description": "Drop videos with fewer than this many views. Turns on detail enrichment so compact Shorts labels are not mis-filtered." }, "publishedAfter": { "title": "Published After", "type": "string", "description": "Only keep videos published on or after this date (YYYY-MM-DD). Turns on detail enrichment." } } }, "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 } } } } } } } } } }