Skip to content
Scrappa Get API key
Facebook API 1 credit/request

Facebook Profile API

GET https://scrappa.co/api/facebook/profile?handle=zuck

Get the identity of a public Facebook profile from its handle: name, follower count, talking-about count, bio text, category, canonical URL and profile image. One request returns one profile identity. Counts are parsed from the English locale and returned as null when the locale does not take.

Facebook Profile API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/facebook/profile?handle=zuck
Auth header
x-api-key
Cost
1 credit/request
handle = zuck
Response preview
200 OK
{
    "success": true,
    "page": {
        "name": "Mark Zuckerberg",
        "description": "5.2M followers \u00b7 431 following",
        "url": "https://www.facebook.com/zuck",
        "type": "profile",
        "image": "https://...",
        "category": "Public Figure",
        "follower_count": 5200000,
        "following_count": 431,
        "talking_about_count": null,
        "like_count": null
    },
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

handle string Required

Facebook profile handle, without the @ or the facebook.com prefix (e.g. zuck).

Example value zuck

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/facebook/profile?handle=zuck",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/facebook/profile?handle=zuck');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/facebook/profile?handle=zuck', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/facebook/profile?handle=zuck',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/facebook/profile?handle=zuck")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/facebook/profile?handle=zuck", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/facebook/profile?handle=zuck', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/facebook/profile?handle=zuck")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/facebook/profile?handle=zuck", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/facebook/profile?handle=zuck"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/facebook/profile?handle=zuck"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/facebook/profile?handle=zuck',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/facebook/profile?handle=zuck")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success page meta
JSON Response
200 OK
{
    "success": true,
    "page": {
        "name": "Mark Zuckerberg",
        "description": "5.2M followers \u00b7 431 following",
        "url": "https://www.facebook.com/zuck",
        "type": "profile",
        "image": "https://...",
        "category": "Public Figure",
        "follower_count": 5200000,
        "following_count": 431,
        "talking_about_count": null,
        "like_count": null
    },
    "meta": {
        "classification": "ok",
        "billable": true,
        "endpoint_family": "facebook_profile",
        "duration_ms": 4100
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter is missing or malformed, for example a handle with characters Facebook does not allow or a non-numeric id.

{
    "message": "The request validation failed",
    "errors": {
        "handle": [
            "The handle is required."
        ]
    }
}
404

Not Found

The page, profile, group, event, photo, reel, post or listing does not exist, is not public, or was served by Facebook without the requested record. This is the truthful answer, not a temporary fault: it is never billed and retrying the same permalink will not change it.

{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Facebook resource was not found."
    },
    "meta": {
        "billable": false,
        "retryable": false
    }
}
503

Records Not Read

Facebook returned records for this request that the parser could not read. The origin status is 502 and it is reported here as 503 because Cloudflare replaces 502 and 504 bodies with its own page. This request is never billed: the customer received no data.

{
    "success": false,
    "error": {
        "code": "EXTRACTION_MISS",
        "message": "Facebook returned records for this request that could not be read. This request is not billed."
    },
    "meta": {
        "billable": false,
        "retryable": false
    }
}
503

Temporarily Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "success": false,
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Facebook is temporarily unavailable. Please retry."
    },
    "meta": {
        "billable": false,
        "retryable": true
    }
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.