{ "openapi": "3.0.1", "info": { "title": "Facebook Video Search Scraper & Creator Video Catalogue", "description": "Facebook Video Search Scraper finds and extracts videos matching any keyword on Facebook. Get titles, URLs, views, creators, and metadata fast. Perfect for research, trend analysis, and automation workflows needing accurate Facebook video data.", "version": "0.1", "x-build-id": "wCXgF0SOsAwahAEE2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~facebook-video-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-facebook-video-search-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/api-empire~facebook-video-search-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-facebook-video-search-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/api-empire~facebook-video-search-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-facebook-video-search-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Keywords & topics (one per line)", "type": "array", "description": "One search phrase per line - for example: cricket highlights, street food, indie games. Each line is searched separately and every row records the keyword it came from. Despite the field name these are keywords, not URLs (the base actor named it this way and the name is kept so existing runs and integrations keep working).", "items": { "type": "string" } }, "maxVideos": { "title": "How many videos per keyword?", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Between 1 and 1000 matching videos per keyword. Facebook's search feed returns roughly 7-8 results per page, so larger numbers simply mean more pages and a longer run. Start at 10 while you shape the output.", "default": 10 }, "includeCreatorCatalogue": { "title": "Fetch each creator's video catalogue", "type": "boolean", "description": "ON: for every creator surfaced by your keywords, also fetch their public videos tab and attach it to the row as creatorCatalogue. Measured live on 13 creators: 9 videos per creator, every one carrying play count, reaction count, publish date, caption and hashtags. Each creator is fetched ONCE per run - ten matching clips by the same page cost one request. OFF: search rows only, no extra requests.", "default": true }, "catalogueVideosPerCreator": { "title": "Catalogue videos per creator", "minimum": 1, "maximum": 50, "type": "integer", "description": "Upper bound on the catalogue videos attached to each creator. HONEST CEILING: Facebook's videos tab renders 9 full video nodes per creator and no more - the cursor it hands out cannot be replayed logged out, so anything above 9 simply returns 9. Lower it to keep rows compact.", "default": 9 }, "maxCreatorsToFetch": { "title": "Maximum creator catalogues per run", "minimum": 1, "maximum": 500, "type": "integer", "description": "Budget cap on how many DISTINCT creators get a catalogue fetch in one run. Creators beyond the cap still produce full search rows; their catalogue block reports fetchStatus \"skipped_creator_budget\" instead of pretending to be empty.", "default": 25 }, "onlyVerifiedCreators": { "title": "Verified creators only", "type": "boolean", "description": "Keep only rows whose creator carries Facebook's verified badge. IMPORTANT CAVEAT: Facebook omits the verification flag entirely on story-shaped search results, and a missing flag is normalised to false - so false means \"verified badge not present in this payload\", which is not the same as \"confirmed not verified\". Turning this on can therefore drop genuinely verified creators. Measured on a live 20-row run: 3 of 20 creators carried the badge.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Your proxy selection is honoured as supplied (the base actor ignored it and forced Residential). Residential remains the recommended default: from an unproxied datacentre address Facebook's search API answers HTTP 200 with a rate-limit error and zero results. The creator videos tab, by contrast, was measured working on every tier including no proxy." } } }, "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 } } } } } } } } } }