{ "openapi": "3.0.1", "info": { "title": "Facebook Events Scraper — Search Events, Pages & URLs", "description": "Scrape public Facebook events without logging in. Search by keyword, location and date, collect events from city and organizer pages, or provide event URLs and IDs. Get names, dates, venues, ticket links, hosts and attendance, with caching that skips previously scraped events on repeat runs.", "version": "1.0", "x-build-id": "a4WplCIhZkJIVZbsH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~facebook-events-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-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/confidential_gnat~facebook-events-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-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/confidential_gnat~facebook-events-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-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": { "startUrls": { "title": "Facebook URLs", "type": "array", "description": "Event pages (facebook.com/events/123...), event search pages (facebook.com/events/search/?q=music), city event pages (facebook.com/events/explore/bend-oregon/108137335874390, optionally ending in /today, /tomorrow, /this_week, /this_weekend or /next_week) or the page of an organizer (facebook.com/pagename). Pages and groups that need a login are not supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Optional. Keywords to search Facebook events for, for example concerts or yoga. Added to the URLs above.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Optional. A city or place added to each keyword search, for example London (\"concerts in London\"). Facebook's logged-out search has no exact place filter, so results are best-effort." }, "dateFrom": { "title": "Date from", "type": "string", "description": "Optional. For keyword searches: only events starting on or after this date (YYYY-MM-DD). Several date windows return more events than one wide window." }, "dateTo": { "title": "Date to", "type": "string", "description": "Optional. For keyword searches: only events starting on or before this date (YYYY-MM-DD)." }, "eventIds": { "title": "Event IDs", "type": "array", "description": "Optional. Facebook event IDs or event URLs to scrape directly, for example 1124937143546348.", "items": { "type": "string" } }, "eventsTimeRange": { "title": "Events time range", "enum": [ "upcoming", "past", "both" ], "type": "string", "description": "Which events to return: upcoming, past or both. Applies to full event details and organizer pages.", "default": "upcoming" }, "eventDetail": { "title": "Level of detail", "enum": [ "full", "list" ], "type": "string", "description": "Full opens each event page for description, times, venue, tickets, hosts and attendance. List is about 4 times faster and returns only the name, link, image and date line from the search results.", "default": "full" }, "maxItems": { "title": "Max events per search or page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum events returned for each search keyword, search URL, city events page or organizer page. Facebook shows a logged-out visitor a limited number of keyword search results (often 10 to 30 per keyword); city events pages go much deeper.", "default": 5 }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Optional. When set, events already saved under this project name in a previous run are skipped (and not charged). Use the same name on each scheduled run to get only new events. Leave empty to scrape everything." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Facebook's public pages work without a proxy from many networks. Turn on Apify proxy if you see blocks, especially on large runs.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }