> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Facebook facebook Page API
> Scrape a public Facebook page's details. Call the Facebook facebook Page API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.
Scrape a public Facebook page's details. The page or user is identified by its URL or username.
## Request
Exactly one of `pageUrl` or `username` is required. A request that sets both, or none, fails with `invalidRequest`.
```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
import { Stophy } from "stophy";
const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.facebook.page({ username: "NASA" });
console.log(result.data);
```
```python Python icon="python" theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.facebook.page(username="NASA")
print(result["data"])
```
```bash cURL icon="terminal" theme={null}
curl -X POST https://api.stophy.dev/v1/facebook/page \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"username":"NASA"}'
```
```bash CLI icon="square-terminal" theme={null}
stophy facebook page --username NASA
```
## Response
If successful, the response body contains the standard envelope. `data` contains the page's name, category, followers, bio and public contact details.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"pageId": "54971236771",
"username": "NASA",
"pageUrl": "https://www.facebook.com/NASA",
"name": "NASA - National Aeronautics and Space Administration",
"category": "Government organization",
"isVerified": true,
"followers": 28717285,
"talkingAboutThis": 77407,
"bio": "Explore the universe and discover our home planet. \nThere's space for everybody. ✨",
"email": "name@example.com",
"websites": ["https://www.nasa.gov/nasa-app/"],
"avatarUrl": "https://scontent-phl2-1.xx.fbcdn.net/v/t39.30808-1/243095782_416661036495945_3843362260429099279_n.png?stp=dst-png&cstp…",
"coverUrl": "https://scontent-phl2-1.xx.fbcdn.net/v/t39.99422-6/809146614_4484013928506139_3181913787670602881_n.png?stp=dst-jpg_tt6…"
},
"creditsUsed": 1,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
## Billing
Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.
## Pagination
This method is not paginated. A single request returns the complete result.
## Related methods
* [Facebook facebook Page Posts](/api-reference/endpoint/facebook-page-posts): Accepts `pageUrl`. Scrape a public Facebook page's posts.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/facebook/page
openapi: 3.1.0
info:
title: Stophy API
version: '1'
description: >-
Every endpoint is a POST that takes its input as a JSON object body. Unknown
fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and
empty nested lists are not sent.
Text comes back whole. To get shorter responses, add
?maxTextLength= to the URL. Every text value longer than that is
cut and ends with …. A screenshot is never cut, and a page whose text was
cut has isTruncated set to true.
x-credits is what one call costs. Every call costs the same, whatever it
returns, unless an operation's description says it costs per 10 results, or
per second of audio. Then x-credits is the lowest price and x-credits-max
the most one call can cost. Where an operation takes limit, send it to
return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to
get the next page. When it has a page, send the next page number.
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
paths:
/v1/facebook/page:
post:
summary: Scrape a public Facebook page's details
description: Costs 1 credit per call.
operationId: facebookPage
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pageUrl:
type: string
description: >-
Link to the Facebook page, like
https://www.facebook.com/NASA. Send this or username.
username:
type: string
description: Facebook page name, like NASA. Send this or pageUrl.
sendOne:
- pageUrl
- username
additionalProperties: false
example:
username: NASA
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
pageId:
type: string
username:
type: string
pageUrl:
type: string
format: uri
name:
type: string
category:
type: string
isVerified:
type: boolean
followers:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
likes:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
talkingAboutThis:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
bio:
type: string
address:
type: string
phone:
type: string
email:
type: string
websites:
type: array
items:
type: string
priceRange:
type: string
avatarUrl:
type: string
format: uri
coverUrl:
type: string
format: uri
required:
- pageUrl
- isVerified
- websites
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: >-
Cut every text value in the response to this many characters. A value
that was cut ends with …, and a page whose text was cut has isTruncated
set to true. A screenshot is never cut. Leave it out to get the full
text.
schema:
type: integer
minimum: 1
headers:
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
CreditsUsed:
description: Credits this call used.
schema:
type: integer
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- tooManyInFlight
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
securitySchemes:
apiKey:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.