> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Profile events
> Fetches a public Facebook page's events (from its `/events` tab). Each event includes its name, url, start time (unix + ISO + the human date line), past/online/canceled flags, kind, cover photo, place (name/type/city/coords when present), and creator. Returns the first page plus a `paging.cursor` / `paging.hasNextPage` for the next page.
**Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
```text Prompt
I want to make an API call to /v1/facebook/profile/events. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/facebook/profile/events
Description: Fetches a public Facebook page's events (from its `/events` tab). Each event includes its name, url, start time (unix + ISO + the human date line), past/online/canceled flags, kind, cover photo, place (name/type/city/coords when present), and creator. Returns the first page plus a `paging.cursor` / `paging.hasNextPage` for the next page.
Required Headers:
- x-api-key: Your API key
Parameters:
- url (string) [required]: Public Facebook page URL, e.g. https://www.facebook.com/WebSummitHQ
- cursor (string): The `paging.cursor` from a previous call, to fetch the next page.
- cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
Example Response:
{
"data": {
"events": [
{
"id": "668090121966465",
"name": "Tech For Good",
"url": "https://www.facebook.com/events/668090121966465/",
"startTimestamp": 1696946400,
"startDate": "2023-10-10T14:00:00.000Z",
"dayTimeSentence": "Tue, 10 Oct 2023",
"isPast": true,
"isHappeningNow": false,
"isCanceled": false,
"isOnline": true,
"eventKind": "PUBLIC_TYPE",
"onlineEventType": "FB_LIVE",
"coverPhotoUrl": "https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-6/384120671_713131144187494_3360755611233295705_n.png?stp=c118.0.1044.720a_dst-png&cstp=mx1044x720&ctp=s235x165…",
"coverVideoUrl": null,
"place": null,
"creator": {
"id": "100064718437596",
"name": "Web Summit",
"url": "https://www.facebook.com/WebSummitHQ"
}
}
],
"eventCount": 8,
"totalCount": 53,
"paging": {
"cursor": "AQHTzpw3vw12YnEoNjwAzXeqFikbX05iBiF0cksdsggf0zIprzBbHWTVou_cF6-tujzH3CUxj4zFGrXccF2jdvv6aQ",
"hasNextPage": true
},
"fetchedAt": "2026-10-05T14:43:04.505Z"
},
"meta": {
"requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
"creditsCharged": 1,
"creditsRemaining": 4999,
"cached": false
}
}
Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
```
## OpenAPI
````yaml /api-reference/openapi.json get /v1/facebook/profile/events
openapi: 3.0.3
info:
title: Scraperize API
version: 1.0.0
description: >-
Extract public data from social media platforms as clean JSON. Endpoints are
split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.
## Authentication
Send your API key in the `x-api-key` header (or `Authorization: Bearer
`). Create keys in your dashboard.
## Credits
Each successful live scrape costs **1 credit**. Credits are prepaid and
never expire.
## Caching
Every endpoint accepts an optional `cache_max_age`
(`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
**0 credits**.
## Responses
Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
`{ "error": { "code", "message", "requestId" } }` with a matching HTTP
status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
`cached`, and (on a hit) `cachedAt`.
## Rate limits
Requests are limited per team per minute; over the limit returns `429` with
a `Retry-After` header.
servers:
- url: https://api.scraperize.com
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Twitter
description: Twitter / X scraping endpoints
- name: Facebook
description: Facebook scraping endpoints
- name: Linkme
description: Linkme (link.me) scraping endpoints
- name: Amazon
description: Amazon (creator shop / storefront) scraping endpoints
- name: Linkbio
description: Linkbio (lnk.bio) scraping endpoints
- name: Pillar
description: Pillar (pillar.io) scraping endpoints
- name: Komi
description: Komi (komi.io) scraping endpoints
- name: Linktree
description: Linktree (linktr.ee) scraping endpoints
- name: Kick
description: Kick (kick.com) scraping endpoints
- name: Snapchat
description: Snapchat (snapchat.com) scraping endpoints
- name: Telegram
description: Telegram (t.me) scraping endpoints
- name: LinkedIn
description: LinkedIn scraping endpoints
- name: Twitch
description: Twitch scraping endpoints
- name: TikTok
description: TikTok (tiktok.com) scraping endpoints
paths:
/v1/facebook/profile/events:
get:
tags:
- Facebook
summary: Profile events
description: >-
Fetches a public Facebook page's events (from its `/events` tab). Each
event includes its name, url, start time (unix + ISO + the human date
line), past/online/canceled flags, kind, cover photo, place
(name/type/city/coords when present), and creator. Returns the first
page plus a `paging.cursor` / `paging.hasNextPage` for the next page.
parameters:
- name: url
in: query
required: true
description: Public Facebook page URL, e.g. https://www.facebook.com/WebSummitHQ
schema:
type: string
example: https://www.facebook.com/WebSummitHQ
- name: cursor
in: query
required: false
description: The `paging.cursor` from a previous call, to fetch the next page.
schema:
type: string
- name: cache_max_age
in: query
required: false
description: >-
Optional. Return a cached result if one this age or newer exists —
served for **0 credits** with `meta.cached=true` and
`meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
refreshes the cache. Omit to always scrape fresh.
schema:
type: string
enum:
- 1d
- 3d
- 7d
- 14d
- 30d
example: 7d
responses:
'200':
description: The page events.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
events:
type: array
items:
type: object
eventCount:
type: integer
paging:
type: object
properties:
cursor:
type: string
nullable: true
hasNextPage:
type: boolean
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
events:
- id: '668090121966465'
name: Tech For Good
url: https://www.facebook.com/events/668090121966465/
startTimestamp: 1696946400
startDate: '2023-10-10T14:00:00.000Z'
dayTimeSentence: Tue, 10 Oct 2023
isPast: true
isHappeningNow: false
isCanceled: false
isOnline: true
eventKind: PUBLIC_TYPE
onlineEventType: FB_LIVE
coverPhotoUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-6/384120671_713131144187494_3360755611233295705_n.png?stp=c118.0.1044.720a_dst-png&cstp=mx1044x720&ctp=s235x165&_nc_cat=110&ccb=1-7&_nc_sid=4bdd9b&_nc_ohc=kiTFPDNbEqYQ7kNvwGYgO5x&_nc_oc=Adou1KWArt9emAQY1YIhpJzybMRm2hwE-pBFEzq0KooBsiJPl8rzf7JtbAVHPddcJkQ&_nc_zt=23&_nc_ht=scontent-los4-1.xx&_nc_gid=gGBQSvb8TFMatppD0utcSw&_nc_ss=7c289&oh=00_AQP3GjgWSnUgg84N3ugcSM8tU_n3CPEwDfDUTMii0_8xVw&oe=6AC98DDB
coverVideoUrl: null
place: null
creator:
id: '100064718437596'
name: Web Summit
url: https://www.facebook.com/WebSummitHQ
- id: '563963522351024'
name: Test
url: https://www.facebook.com/events/563963522351024/
startTimestamp: 1677600900
startDate: '2023-02-28T16:15:00.000Z'
dayTimeSentence: Tue, 28 Feb 2023
isPast: true
isHappeningNow: false
isCanceled: false
isOnline: true
eventKind: PUBLIC_TYPE
onlineEventType: FB_LIVE
coverPhotoUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-6/331416647_3352736264991172_6745313760654182826_n.png?stp=c118.0.1044.720a_dst-png&cstp=mx1044x720&ctp=s235x165&_nc_cat=102&ccb=1-7&_nc_sid=4bdd9b&_nc_ohc=FN_y8G1SNS4Q7kNvwFBgOHs&_nc_oc=Adoz7ytokUQuznO9nSbVfUbEf_d052t1-jm-RMOjQllL6bNhN6dSr4lAZuvNaVUt6tU&_nc_zt=23&_nc_ht=scontent-los4-1.xx&_nc_gid=gGBQSvb8TFMatppD0utcSw&_nc_ss=7c289&oh=00_AQO__S0K7-k7lXEmfoPuioZtw3BSa28YqaIzNt_hanvC3Q&oe=6AC98D09
coverVideoUrl: null
place: null
creator:
id: '100064718437596'
name: Web Summit
url: https://www.facebook.com/WebSummitHQ
- id: '1144488746245969'
name: Restream Test
url: https://www.facebook.com/events/1144488746245969/
startTimestamp: 1677586500
startDate: '2023-02-28T12:15:00.000Z'
dayTimeSentence: Tue, 28 Feb 2023
isPast: true
isHappeningNow: false
isCanceled: false
isOnline: true
eventKind: PUBLIC_TYPE
onlineEventType: FB_LIVE
coverPhotoUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-6/333968926_594306715889858_5541687746335947839_n.png?stp=c118.0.1044.720a_dst-png&cstp=mx1044x720&ctp=s235x165&_nc_cat=100&ccb=1-7&_nc_sid=4bdd9b&_nc_ohc=ReAKSasns5gQ7kNvwG33FAO&_nc_oc=AdrTkhC-dMF-hoJ6NR0c0l5i0eP7YIXHMIdkYOSLj-CVaOR6imp3p9-Rueq7gdiMZ9w&_nc_zt=23&_nc_ht=scontent-los4-1.xx&_nc_gid=gGBQSvb8TFMatppD0utcSw&_nc_ss=7c289&oh=00_AQO8VpTyuE3M7NmHeOXaBp6BQlskq5sjBXltCHonjUelRQ&oe=6AC970B6
coverVideoUrl: null
place: null
creator:
id: '100064718437596'
name: Web Summit
url: https://www.facebook.com/WebSummitHQ
eventCount: 8
totalCount: 53
paging:
cursor: >-
AQHTzpw3vw12YnEoNjwAzXeqFikbX05iBiF0cksdsggf0zIprzBbHWTVou_cF6-tujzH3CUxj4zFGrXccF2jdvv6aQ
hasNextPage: true
fetchedAt: '2026-10-05T14:43:04.505Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'400':
description: Invalid or expired cursor.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: BAD_REQUEST
message: The request was invalid.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'401':
description: Missing, invalid, or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: API key required — pass it in the `x-api-key` header.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'402':
description: Not enough credits for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INSUFFICIENT_CREDITS
message: >-
This request costs 1 credit, but your balance is 0. Top up
to continue.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'404':
description: Page not found / no public events.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: NOT_FOUND
message: >-
The requested content was not found (it may not exist, be
deleted, or be private).
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'422':
description: Invalid query parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: VALIDATION_ERROR
message: Request validation failed
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
- path: url
message: Required
'429':
description: Over the per-minute rate limit — honour `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: >-
Rate limit exceeded — max 100 requests per 60s. Retry in
~30s.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'503':
description: >-
Temporarily unavailable — retry after `Retry-After`. `error.code`
tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
`EXTRACTION_FAILED` (the source returned unexpected data),
`PLATFORM_UNAVAILABLE` (the source is down), or
`SERVICE_UNAVAILABLE` (we are at capacity).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UPSTREAM_BLOCKED
message: >-
The source is temporarily unavailable. Please try again
shortly.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: NOT_FOUND
message:
type: string
example: The requested content was not found.
requestId:
type: string
example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
type: array
items:
type: object
description: Present on validation errors.
required:
- code
- message
- requestId
required:
- error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Your API key. Send it in the `x-api-key` header (or `Authorization:
Bearer `). Create and manage keys from your dashboard.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.