{ "openapi": "3.0.1", "info": { "title": "Facebook Reels Scraper", "description": "Scrape public Facebook Reels from Pages, profiles or direct Reel URLs. One row per Reel: caption, hashtags, mentions, plays, reactions, comments, shares, creator details, thumbnail, HD/SD video URLs, audio/music metadata and subtitle tracks. No Facebook login or cookies.", "version": "1.0", "x-build-id": "rdJ2QYv15nx50OH8K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~facebook-reels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-facebook-reels-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/coregent~facebook-reels-scraper/runs": { "post": { "operationId": "runs-sync-coregent-facebook-reels-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/coregent~facebook-reels-scraper/run-sync": { "post": { "operationId": "run-sync-coregent-facebook-reels-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": "Facebook URLs or usernames", "type": "array", "description": "Public Facebook Pages, profiles or Reels — mix them freely; each one is detected automatically. A Page/profile (https://www.facebook.com/natgeo, its /reels/ tab, profile.php?id=…, or just the username) returns its public Reels, newest first. A Reel URL (/reel/ or a /videos/ link — most reliable; /share/r/… and fb.watch/… share links are followed through Facebook's redirect) returns that one Reel. Facebook groups, posts and photos are not Reels and are rejected with a reason.", "default": [ "https://www.facebook.com/natgeo/reels/" ], "items": { "type": "string" } }, "resultsLimit": { "title": "Maximum Reels per Page/profile", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many Reels to save from EACH Page/profile input, newest first. A direct Reel URL always returns at most one Reel. You pay only for the Reels you receive.", "default": 100 }, "reelsNewerThan": { "title": "Reels newer than", "type": "string", "description": "Only Reels published after this point, e.g. \"24 hours\", \"7 days\", \"30 days\" or a date such as \"2026-09-01\". The Reels tab is newest-first, so the Actor stops paging a Page/profile as soon as its Reels are older than this — useful for monitoring. Applies to Page/profile inputs; a Reel URL you supply directly is always returned. Leave empty for no date limit.", "default": "" }, "includeVideoUrls": { "title": "Include direct video URLs", "type": "boolean", "description": "Return the direct HD and SD .mp4 URLs Facebook serves for each Reel. They are temporary (see videoUrlExpiresAt). Turn off if you only need metadata. Never charged separately.", "default": true }, "includeAudio": { "title": "Include audio / music metadata", "type": "boolean", "description": "Return the Reel's soundtrack as Facebook shows it: title, artist, type (library music or the creator's own sound) and the audio id. Never charged separately.", "default": true }, "includeSubtitles": { "title": "Include subtitle tracks", "type": "boolean", "description": "Return the native caption tracks (.srt URLs with language) Facebook publishes for a Reel, where it publishes any. No speech-to-text is run. Never charged separately.", "default": true }, "includeUnavailableRows": { "title": "Include failed inputs as empty rows", "type": "boolean", "description": "Add one empty row per input that returned nothing (deleted Reel, unknown profile, no Reels, blocked), with a status saying why. These rows are never charged. Off by default so the dataset contains only Reels; the reasons are always in the log and the RUN_SUMMARY record.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy (datacenter) is used by default. Apify RESIDENTIAL proxy is not supported and the run fails if it is selected — supply your own residential provider under Custom proxy URLs instead.", "default": { "useApifyProxy": true } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Log each input's detected target type and every failed request.", "default": false } } }, "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 } } } } } } } } } }