{ "openapi": "3.0.1", "info": { "title": "Facebook Comments Scraper", "description": "Extract comments from any public Facebook post, reel, or video. Get comment text, date, author name, profile link, reaction count, and reply count. Configure output fields, filter by date, sort results. Export as JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "WcDcfVfI6dQ9VdUYy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadsbrary~facebook-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadsbrary-facebook-comments-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/leadsbrary~facebook-comments-scraper/runs": { "post": { "operationId": "runs-sync-leadsbrary-facebook-comments-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/leadsbrary~facebook-comments-scraper/run-sync": { "post": { "operationId": "run-sync-leadsbrary-facebook-comments-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": "Post URLs", "type": "array", "description": "List of public Facebook post, reel, or video URLs to scrape comments from.\n\nSupported formats:\n- `https://www.facebook.com/{page}/posts/{post_id}`\n- `https://www.facebook.com/reel/{reel_id}`\n- `https://www.facebook.com/{page}/videos/{video_id}`\n- `https://www.facebook.com/photo?fbid={photo_id}`", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "resultsLimit": { "title": "Max comments per post", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of top-level comments (and replies if enabled) to extract per post URL.", "default": 100 }, "viewOption": { "title": "Sort order", "enum": [ "RANKED_UNFILTERED", "RANKED_THREADED", "RECENT_ACTIVITY" ], "type": "string", "description": "How to sort the returned comments.", "default": "RANKED_UNFILTERED" }, "includeNestedComments": { "title": "Include replies (nested comments)", "type": "boolean", "description": "When enabled, also extract replies to top-level comments (up to 2 levels deep). Increases the total number of items returned.", "default": false }, "onlyCommentsNewerThan": { "title": "Only comments newer than", "type": "string", "description": "Filter out older comments. Supports:\n- Absolute dates: `2024-01-01` or `2024-06-15T12:00:00Z`\n- Relative values: `1 day`, `2 weeks`, `3 months`, `1 year`\n\nWhen set, sorting is automatically switched to **Newest first** so the filter works correctly." }, "includeDate": { "title": "Date", "type": "boolean", "description": "Include the comment timestamp in the output.", "default": true }, "includeAuthor": { "title": "Author name", "type": "boolean", "description": "Include the commenter's display name.", "default": true }, "includeProfileUrl": { "title": "Author profile URL", "type": "boolean", "description": "Include a link to the commenter's Facebook profile.", "default": true }, "includeLikes": { "title": "Likes / reactions", "type": "boolean", "description": "Include the total reaction count on the comment.", "default": true }, "includeReplies": { "title": "Reply count", "type": "boolean", "description": "Include the number of replies to the comment.", "default": true }, "includePostUrl": { "title": "Post URL & title", "type": "boolean", "description": "Include the post URL and title in each comment row.", "default": true }, "includeCommentUrl": { "title": "Comment URL", "type": "boolean", "description": "Include a direct link to the comment.", "default": true }, "includePostId": { "title": "Post ID", "type": "boolean", "description": "Include the numeric Facebook post ID.", "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 } } }, "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 } } } } } } } } } }