> ## 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.
# Group
> Fetches a public Facebook group's About-page information (from its `/about` page): name, id, vanity, description, privacy, type, member count, creation date + history, cover photo, admins/moderators, and the group rules. Pass `url` OR `groupId`.
**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/group. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/facebook/group
Description: Fetches a public Facebook group's About-page information (from its `/about` page): name, id, vanity, description, privacy, type, member count, creation date + history, cover photo, admins/moderators, and the group rules. Pass `url` OR `groupId`.
Required Headers:
- x-api-key: Your API key
Parameters:
- url (string): **Required — provide one of `url` or `groupId`.** Public Facebook group URL (sub-pages like /about work too).
- groupId (string): **Required — provide one of `url` or `groupId`.** Numeric Facebook group id (faster if you have it).
- 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": {
"group": {
"id": "367172990112802",
"name": "Cristiano Ronaldo CR 7",
"url": "https://www.facebook.com/groups/cristianoronaldo404/about/",
"vanity": "cristianoronaldo404",
"description": "Cristiano Ronaldo dos Santos Aveiro GOIH ComM is a Portuguese professional footballer who plays as a forward for Premier League club Manchester United and capta…",
"privacy": {
"label": "Public group",
"icon": "globe-americas"
},
"groupType": "GROUP",
"memberCount": 1184205,
"memberCountText": "1.2M members",
"activity": {
"postsLastDay": 0,
"postsLastMonth": 0,
"newMembersText": "No new members in the last week"
},
"createdTimestamp": 1416202227,
"createdAt": "2014-11-17T05:30:27.000Z",
"historySummary": "Group created on 17 November 2014. Name last changed on 8 July 2022.",
"coverPhotoUrl": null,
"admins": {
"count": 3,
"profiles": [
{
"id": "pfbid02ejSBAvbRYFR3vnmPXzdVZAdLbpwDmTbNBmsT8FixHgvDLgomKToW9FobussSUmXal",
"name": "សីហា កំពត",
"url": "https://www.facebook.com/pfbid02ejSBAvbRYFR3vnmPXzdVZAdLbpwDmTbNBmsT8FixHgvDLgomKToW9FobussSUmXal",
"avatarUrl": "https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/330989668_765158771278136_4230346575304946020_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx946x960&ctp=p64x64&_nc_cat=110…"
}
]
},
"moderators": {
"count": 11,
"profiles": [
{
"id": "100094571611307",
"name": "Scarlett Rose",
"url": "https://www.facebook.com/100094571611307",
"avatarUrl": "https://scontent-los4-1.xx.fbcdn.net/v/t1.30497-1/453178253_471506465671661_2781666950760530985_n.png?stp=cp0_dst-png&cstp=mx2048x2048&ctp=s64x64&_nc_cat=1&ccb=…"
}
]
},
"adminModeratorSentence": "Janice and 2 other members are admins. Alice and 10 other members are moderators.",
"rules": [
{
"title": "anybody can join this group, but don’t post bad.",
"description": "it’s is a only Ertugrul Gazi fans group, so you can post for Ertugrul pictures, family picture, dirilis series and good qualityful videos. If you share others g…"
}
],
"viewerJoinState": "CAN_JOIN"
},
"fetchedAt": "2026-10-05T14:43:20.223Z"
},
"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/group
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/group:
get:
tags:
- Facebook
summary: Group
description: >-
Fetches a public Facebook group's About-page information (from its
`/about` page): name, id, vanity, description, privacy, type, member
count, creation date + history, cover photo, admins/moderators, and the
group rules. Pass `url` OR `groupId`.
parameters:
- name: url
in: query
required: false
description: >-
**Required — provide one of `url` or `groupId`.** Public Facebook
group URL (sub-pages like /about work too).
schema:
type: string
example: https://www.facebook.com/groups/cristianoronaldo404
- name: groupId
in: query
required: false
description: >-
**Required — provide one of `url` or `groupId`.** Numeric Facebook
group id (faster if you have it).
schema:
type: string
example: '367172990112802'
- 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 group About information.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
group:
type: object
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
group:
id: '367172990112802'
name: Cristiano Ronaldo CR 7
url: https://www.facebook.com/groups/cristianoronaldo404/about/
vanity: cristianoronaldo404
description: >-
Cristiano Ronaldo dos Santos Aveiro GOIH ComM is a
Portuguese professional footballer who plays as a forward
for Premier League club Manchester United and captains the
Portugal national team.
privacy:
label: Public group
icon: globe-americas
groupType: GROUP
memberCount: 1184205
memberCountText: 1.2M members
activity:
postsLastDay: 0
postsLastMonth: 0
newMembersText: No new members in the last week
createdTimestamp: 1416202227
createdAt: '2014-11-17T05:30:27.000Z'
historySummary: >-
Group created on 17 November 2014. Name last changed on 8
July 2022.
coverPhotoUrl: null
admins:
count: 3
profiles:
- id: >-
pfbid02ejSBAvbRYFR3vnmPXzdVZAdLbpwDmTbNBmsT8FixHgvDLgomKToW9FobussSUmXal
name: សីហា កំពត
url: >-
https://www.facebook.com/pfbid02ejSBAvbRYFR3vnmPXzdVZAdLbpwDmTbNBmsT8FixHgvDLgomKToW9FobussSUmXal
avatarUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/330989668_765158771278136_4230346575304946020_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx946x960&ctp=p64x64&_nc_cat=110&ccb=1-7&_nc_sid=e99d92&_nc_ohc=Z0RnZtS_wfwQ7kNvwGKkFqD&_nc_oc=Adppz5Gw7y7RaBRY1rGCBHci04SS7s-Tl5oa1LkWxjckdZzgvYIWOMhSNmjsFRu5r80&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=72qa-MPu5qwKNzH02mpMdw&_nc_ss=7c289&oh=00_AQMydD2JALTDc3KNPV-gWypu1tQyZxqeSRHvBcIDOskusA&oe=6AC972EF
- id: >-
pfbid03f53C5vw98P2aot5zd3rQmpuUYknCtLQry4FqwH4fuQ68MwyDWgAoi74zFLup8hcl
name: Janice Santa Cruz
url: >-
https://www.facebook.com/pfbid03f53C5vw98P2aot5zd3rQmpuUYknCtLQry4FqwH4fuQ68MwyDWgAoi74zFLup8hcl
avatarUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/365299270_307519325150764_1073141960337662542_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx959x959&ctp=s64x64&_nc_cat=111&ccb=1-7&_nc_sid=e99d92&_nc_ohc=Y9PLiPbGJlkQ7kNvwFrmg0i&_nc_oc=AdrbTeRoM-gzFczC2C0Np0ZsvTwtyLnc4wvuYDjMOElUDCDqwkx1jyLMN2_rIH2LFRs&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=72qa-MPu5qwKNzH02mpMdw&_nc_ss=7c289&oh=00_AQPVjOPzOj6LLoyqLgDMZ0FAUHNdwfVa2tWghVmDG8rlWw&oe=6AC97C9C
- id: '100063901998836'
name: Sexa Baba
url: https://www.facebook.com/100063901998836
avatarUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/296289642_444367874369942_4368707394955595771_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx520x520&ctp=s64x64&_nc_cat=111&ccb=1-7&_nc_sid=2d3e12&_nc_ohc=WnGKdKTVn8AQ7kNvwE4BBWN&_nc_oc=Adpm7Ptk-GhdiIBBLDaf68nG_Cuqc7WxNnJVXQD1bchzfbExaNGxDZ2s005k1FXiq1Y&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=72qa-MPu5qwKNzH02mpMdw&_nc_ss=7c289&oh=00_AQOBycy-JjFZdZi5J5bIRmnXIVPBOLQ8NJfNIlpeeNy4qQ&oe=6AC9A08F
moderators:
count: 11
profiles:
- id: '100094571611307'
name: Scarlett Rose
url: https://www.facebook.com/100094571611307
avatarUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t1.30497-1/453178253_471506465671661_2781666950760530985_n.png?stp=cp0_dst-png&cstp=mx2048x2048&ctp=s64x64&_nc_cat=1&ccb=1-7&_nc_sid=b224c7&_nc_ohc=v_XEyutpHp0Q7kNvwFcO8kh&_nc_oc=AdqQzms0u9JE-Ltxj5LrK8qvsQ-0lc7PeEmWrq30yBRRfdebaqpUBF8HuwxSxQmnQUI&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_ss=7c289&oh=00_AQNLv6lnDomskeH_oHjiLdKghs9tpf-_8AIjBxv1zs9CTw&oe=6AEB2AFA
- id: >-
pfbid0m7183yWvaD6t6GJJNqL17UHSxPJJ71vKqmqZfrXBVtRUi5enHJ9mnWTvhZiESBY1l
name: James Panugaling
url: >-
https://www.facebook.com/pfbid0m7183yWvaD6t6GJJNqL17UHSxPJJ71vKqmqZfrXBVtRUi5enHJ9mnWTvhZiESBY1l
avatarUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/499725626_568313852988803_115812218904916893_n.jpg?stp=c0.0.526.526a_cp0_dst-jpg_tt6&cstp=mx526x526&ctp=s64x64&_nc_cat=103&ccb=1-7&_nc_sid=e99d92&_nc_ohc=K_GOc1E42XEQ7kNvwGOKHjL&_nc_oc=AdpWL2az1Q_NSu_wEDqXYrK0QvJ4NNx8xBm_9pu5Axv58gyWjfsxhD0a5AL1WkZGMVw&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=72qa-MPu5qwKNzH02mpMdw&_nc_ss=7c289&oh=00_AQOs-ek-5kPtahd0Hzk5_q6qiLpeiKMGS1MP3zRFfn7rVg&oe=6AC99A1F
- id: >-
pfbid02TbnVTzEvrhL8g67xGX3ejdErUK7aE2EQZfRAFStT6mgQ9TGwegFwQxziRn1tK6aXl
name: Babangida Sani
url: >-
https://www.facebook.com/pfbid02TbnVTzEvrhL8g67xGX3ejdErUK7aE2EQZfRAFStT6mgQ9TGwegFwQxziRn1tK6aXl
avatarUrl: >-
https://scontent-los4-1.xx.fbcdn.net/v/t39.30808-1/350107612_2406071749567649_6302386781779485243_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx492x492&ctp=s64x64&_nc_cat=107&ccb=1-7&_nc_sid=e99d92&_nc_ohc=L3_4zSShwsYQ7kNvwGi_7BS&_nc_oc=AdpxzKCAbdnOdpnbrP0mEsdfiAhE1-U08Eh1UKmzodm1fCxFVy2eKD6qhcek1MOhxw4&_nc_zt=24&_nc_ht=scontent-los4-1.xx&_nc_gid=72qa-MPu5qwKNzH02mpMdw&_nc_ss=7c289&oh=00_AQN0Jm_TGg-als07oWFy03oSwnTSEwWR6V41qY0PsFHSiQ&oe=6AC9927E
adminModeratorSentence: >-
Janice and 2 other members are admins. Alice and 10 other
members are moderators.
rules:
- title: anybody can join this group, but don’t post bad.
description: >-
it’s is a only Ertugrul Gazi fans group, so you can
post for Ertugrul pictures, family picture, dirilis
series and good qualityful videos. If you share others
group or page i will removed you.
viewerJoinState: CAN_JOIN
fetchedAt: '2026-10-05T14:43:20.223Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'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: Group not found / private / unavailable.
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 (missing url and groupId).
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.