{ "openapi": "3.0.1", "info": { "title": "All-in-One Facebook Scraper", "description": "Collects public Facebook Pages, posts, followers and following, videos, photo albums, Marketplace listings and video search results through a single Actor. The mode is selected per run; each mode takes its own input and returns that dataset's fields, with optional enrichment attached to each row.", "version": "0.1", "x-build-id": "dgQkV7lciFq90LH5y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thenetaji~facebook-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thenetaji-facebook-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/thenetaji~facebook-scraper/runs": { "post": { "operationId": "runs-sync-thenetaji-facebook-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/thenetaji~facebook-scraper/run-sync": { "post": { "operationId": "run-sync-thenetaji-facebook-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": [ "scraperType" ], "properties": { "scraperType": { "title": "What to collect", "enum": [ "pageProfile", "pagePosts", "pageCollection", "pageVideos", "pageAlbums", "marketplaceListings", "marketplaceItem", "videoSearch" ], "type": "string", "description": "Choose the dataset for this run, then fill in the section for that mode below.", "default": "pageProfile" }, "page": { "title": "Facebook Pages", "type": "array", "description": "A Facebook Page's username (the part after facebook.com/), its numeric ID, or the full facebook.com// link.", "items": { "type": "string" } }, "includeAbout": { "title": "Include About details", "type": "boolean", "description": "Adds the Page's About section — category, contact details, website and social links, and business information where the Page is a business.", "default": true }, "includeTransparency": { "title": "Include Page transparency", "type": "boolean", "description": "Adds Page Transparency details — creation date, admin country information, ad status and confirmed owner.", "default": false }, "collection": { "title": "Which list", "enum": [ "followers", "following" ], "type": "string", "description": "Collect the accounts following the Page, or the accounts the Page itself follows.", "default": "followers" }, "addonAccountProfile": { "title": "Fetch each account's profile", "type": "boolean", "description": "Swap each follower/following row's thin record for that account's full public profile and About details. Adds one request and a billable event per row.", "default": false }, "category": { "title": "Marketplace category", "type": "string", "description": "Optional Marketplace category slug, for example `vehicles` or `electronics`. Leave empty to browse everything." }, "addonListingDetails": { "title": "Fetch full listing details", "type": "boolean", "description": "Attach each browsed Marketplace listing's full detail record. Adds one request and a billable event per listing.", "default": false }, "itemId": { "title": "Marketplace listings", "type": "array", "description": "Marketplace listing IDs or full facebook.com/marketplace/item// URLs, one per line.", "items": { "type": "string" } }, "includeRelated": { "title": "Include related listings", "type": "boolean", "description": "Adds the related listings Facebook shows alongside the requested Marketplace listing — roughly twenty of them, attached to that listing's own row. Facebook offers no way to request more, and they cost no extra charge because they arrive in the same request.", "default": false }, "searchQuery": { "title": "Search terms", "type": "array", "description": "Keywords or phrases to search Facebook videos for, one per line. Each term is searched separately and every result records the term it came from.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Maximum records to save. Set `0` to continue until no further records are available.", "default": 50 } } }, "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 } } } } } } } } } }