Skip to content

Structured Facebook data: send queries. Cursor-paginated, 1 credit per successful call.

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/facebook-event-scraper/Open in Playground

Call GET /api/v2/facebook-event-scraper/ with queries. The results are in data.events; send data.next_cursor back as cursor to get the next page. 5 optional parameters refine the call (see Parameters).

Terminal window
curl -G "https://api.scrapier.io/api/v2/facebook-event-scraper/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "queries=Comedy" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
queriesstringyese.g. ComedyEvent search keyword. Required first call.
cursorstringno—Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page.
locationstringno—NOT functional: accepted for input compatibility but never sent to Facebook. Confirmed live -- anonymous events-search resolves a city through a separate typeahead endpoint this scraper doesn't have, and sending a raw city name/id is silently WORSE than omitting it (Facebook accepts it with no error but returns zero events).
locked in cursor
categorystringno—Event category (e.g. 'Comedy', 'Music and audio', 'Sports'). Matched live against Facebook's own category menu (case-insensitive, substring match) -- confirmed to change results.
locked in cursor
time_filterstringno—Date filter: a live preset label ('Today', 'Tomorrow', 'This week', 'This weekend', 'Next week', 'Next weekend', 'In the next month') or an explicit YYYY-MM-DD / YYYY-MM-DD~YYYY-MM-DD range. Confirmed live to change results.
locked in cursor
detailsbooleannofalsetrue = also open each event's own page (+~150 KB each) for full description, address/geo, organizers, child events. false = search-listing fields only.
locked in cursor
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes.
{
"success": true,
"data": {
"queries": "python meetup",
"page": 1,
"page_size": 5,
"events": [
{
"id": "e-1",
"name": "Python Meetup NYC",
"url": "https://www.facebook.com/events/123"
}
],
"next_cursor": "eyJpIjoicHl0aG9uIG1lZXR1cCIsInAiOjJ9"
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.events.

FieldTypeExampleDescription
queriesstringpython meetup—
pageinteger1—
page_sizeinteger5—
eventsarray[1 item]The results.
next_cursorstringeyJpIjoicHl0aG9uIG1lZXR1cCIsInAiOjJ9Pass back as cursor for the next page. null on the last page.
events[].idstringe-1—
events[].namestringPython Meetup NYC—
events[].urlstringhttps://www.facebook.com/events/123—

Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.

const url = "https://api.scrapier.io/api/v2/facebook-event-scraper/";
let params = { queries: "Comedy" };
const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call
const res = await fetch(`${url}?${new URLSearchParams(params)}`, {
headers: { "X-API-Key": "YOUR_API_KEY" },
signal: AbortSignal.timeout(210_000),
});
const body = await res.json();
if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
const data = body.data;
items.push(...(data.events ?? []));
if (!data.next_cursor) break; // null = last page
params = { cursor: data.next_cursor };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • Locked into the cursor: location, category, time_filter, details. Set them on the first call; later pages reuse them.