List Facebook events for a city
Returns the events listed under a Facebook city or region Events explore page. The url must be an Events explore URL ending in the numeric location id (see the example); a plain page URL is rejected with a 400 at 0 credits, and a single page's OWN events are /v1/facebook/profile/events. Each row carries the title, the permalink, the cover image, the start time, the RSVP counts, and on post.ext.event the rendered time line (time_text), location_name (the venue), start_timestamp, is_online, is_past, interested_count and going_count. The same two reading notes apply as on that endpoint: published_at is the event's START time and is routinely in the future, and engagement.views and engagement.likes carry the interested and going RSVP counts because an event has no views or likes. The explore listing carries no description, address, city, host or category, so those are null on a plain call. Send include=details and every event is joined, in the same call, to the per-event details lookup: the description, the street address and city, the coordinates, the hosts (hosts[], and the one-line host credit on post.author.display_name and post.ext.event.host_context_text), the category, the privacy, the cancelled flag and the attendance count land on each row, and a missing cover or RSVP count is filled where the details carry one. Values the row already carried are never replaced. Cost: 1 credit for the page plus 1 credit per event filled from a fresh lookup (at most 12 events a page, so 13 credits at most); rows already in cache are filled for free, rows that could not be filled are refunded, and a repeat of the same call within the cache window is 0 credits. Time: include=details adds 2 to 8 seconds on a fresh page (the lookups run in parallel and the call waits for the slowest, never more than 12 seconds) and nothing when the rows are already cached. The response carries a hydration block itemising rows, lookups, cache hits, credits and milliseconds. Filter by relative time (defaults to all time) and forward the returned cursor for additional pages.
Request
- Base URL: https://www.socialcrawl.dev/v1
- URL: https://www.socialcrawl.dev/v1/facebook/events
- Auth: API key in header x-api-key
Query parameters
Full URL of the city's Facebook Events page.
Relative time window. Defaults to all time when omitted.
Cursor returned by the previous response for pagination.
Set to details (one token only) to fill, on every event in this one call, post.ext.event.description, address, city, latitude, longitude, hosts, host_context_text, category, privacy, is_canceled and attendance_count, and the host credit on post.author.display_name. Holds 1 credit per event (at most 12 a page) and keeps only the rows filled from a fresh lookup; rows already in cache and rows the lookup cannot fill are refunded, so a page is never more than 13 credits. The join takes 2 to 8 seconds on a fresh page, never more than 12, and nothing when the rows are already cached; read data.hydration for the rows, the credits held and kept, and the time. Without it the call is unchanged.
Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. published_after, start_date, from_date, publish_time (yesterday, this-week, this-month, last-3-months, last-6-months) and max_age_days are accepted and applied as since.
Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. published_before, end_date and to_date are accepted and applied as until.
Headers
Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.
Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.
Response
Successful response
Example response
{
"success": true,
"platform": "facebook",
"endpoint": "/v1/facebook/events",
"credits_used": 1,
"credits_remaining": 4999,
"request_id": "req-abc123",
"idempotent_replay": true,
"meta": {
"hint": {
"code": "search_multi",
"message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
"method": "GET",
"path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
}
},
"pagination": {
"next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
"has_more": true,
"page_size": 30,
"stopped_at": "known_id"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.