{ "openapi": "3.0.1", "info": { "title": "Facebook Events Scraper", "description": "Collect public Facebook events by keyword and city, or straight from a page's events tab: name, date, venue address, online or in-person, ticket price line, host and attendance. Facebook's event search is the one search vertical still open to logged-out clients, and this actor uses it.", "version": "0.0", "x-build-id": "T3jgAAm2RvNskkAG2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fanndev~facebook-events-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fanndev-facebook-events-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/fanndev~facebook-events-scraper/runs": { "post": { "operationId": "runs-sync-fanndev-facebook-events-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/fanndev~facebook-events-scraper/run-sync": { "post": { "operationId": "run-sync-fanndev-facebook-events-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "What to look for, e.g. 'yoga', 'live music', 'konser'. Combined with each location below.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "City names, e.g. 'new york', 'jakarta', 'london'. Facebook's event search takes no location parameter a logged-out client can use, so the city is appended to the search term instead - which works: 'konser jakarta' returns Jakarta concerts. Supply locations on their own and each becomes a search in its own right.", "items": { "type": "string" } }, "pages": { "title": "Pages", "type": "array", "description": "Read a page's own events tab instead of searching. Vanity slugs ('MTV') or page URLs. Use this when you already know whose events you want.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Page URLs, for pasting a list straight out of another actor's dataset.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxEventsPerQuery": { "title": "Max events per search or page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Facebook renders roughly seven events per search page and this actor replays its pagination query for the rest.", "default": 30 }, "excludePast": { "title": "Exclude past events", "type": "boolean", "description": "Drop events Facebook marks as finished.", "default": true }, "excludeCanceled": { "title": "Exclude cancelled events", "type": "boolean", "description": "Drop events Facebook marks as cancelled.", "default": true }, "onlyOnline": { "title": "Only online events", "type": "boolean", "description": "Keep virtual events only. Cannot be combined with 'Only in-person events'.", "default": false }, "onlyInPerson": { "title": "Only in-person events", "type": "boolean", "description": "Keep events with a physical venue only.", "default": false }, "nameContains": { "title": "Event name contains", "type": "string", "description": "Case-insensitive substring match against the event name." }, "placeContains": { "title": "Place contains", "type": "string", "description": "Case-insensitive substring match against the venue name, address and city - useful for narrowing a broad search to one neighbourhood." }, "startsAfter": { "title": "Starts on or after", "type": "string", "description": "YYYY-MM-DD. Events from a page's events tab carry a date sentence but no exact timestamp, so a date filter drops them rather than guessing. The log says when that happens." }, "startsBefore": { "title": "Starts on or before", "type": "string", "description": "YYYY-MM-DD." }, "emitSummary": { "title": "Add a run summary record", "type": "boolean", "description": "Append one RUN_SUMMARY record: events collected, online vs in-person, how many carry a venue and an exact start time, and the date range covered.", "default": true }, "exportFormats": { "title": "Extra export files", "type": "array", "description": "Also write the results to the key-value store in these formats. The dataset is always produced regardless.", "items": { "type": "string", "enum": [ "json", "ndjson", "csv", "xlsx" ], "enumTitles": [ "JSON", "NDJSON", "CSV", "Excel (XLSX)" ] }, "default": [] }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Recommended on the Apify platform if you want more than the events Facebook renders on the first page. Facebook serves the rendered first page fine from any IP, but on Apify's datacenter IPs it answers the very first pagination request with \"Rate limit exceeded\" - measured 2026-09-20. Switching the Apify proxy on with the RESIDENTIAL group restored full pagination in the same test (60 ads over 4 pages against 30). Running from your own machine, no proxy is needed at all. The actor logs a warning naming this when it happens, so a short run is never silently mistaken for a short result set.", "default": { "useApifyProxy": 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 } } } } } } } } } }