Get a Facebook profile

Try in Playground

Retrieve public profile identity, photos, counts, introduction, contact fields and page transparency. Business hours are included when the page publishes them.

GET/v1/facebook/profilex-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Public HTTPS Facebook resource URL. Common tracking parameters are stripped; credentials, ports, lookalike hosts, traversal and unsupported paths are rejected.

max 4096 chars

Examplehttps://www.facebook.com/synthetic.page/

get_business_hoursenumquery

true includes published business hours when available.

one of: true, false

include_gated_profileenumquery

Requests only a public gated-profile preview when Facebook exposes one; does not grant access to private content.

one of: true, false

Response fields

Public source adLibrary; null or empty when no value is exposed.

adLibrary.adStatusstringnullable

Always included.

adLibrary.pageIdstringnullable

Always included.

creationDatestringnullable

Public source creationDate; null or empty when no value is exposed.

idstring

Public source id; null or empty when no value is exposed.

namestring

Public source name; null or empty when no value is exposed.

urlstring

Public HTTPS Facebook resource URL. Common tracking parameters are stripped; credentials, ports, lookalike hosts, traversal and unsupported paths are rejected.

absolute HTTPS URL

genderstringnullable

Public source gender; null or empty when no value is exposed.

coverPhotoobjectnullable

Public source coverPhoto; null or empty when no value is exposed.

isBusinessPageActivebooleannullable

Public source isBusinessPageActive; null or empty when no value is exposed.

profilePhotoobjectnullable

Public source profilePhoto; null or empty when no value is exposed.

profilePicLargestringnullable

Public source profilePicLarge; null or empty when no value is exposed.

profilePicMediumstringnullable

Public source profilePicMedium; null or empty when no value is exposed.

profilePicSmallstringnullable

Public source profilePicSmall; null or empty when no value is exposed.

pageIntrostringnullable

Public source pageIntro; null or empty when no value is exposed.

categorystringnullable

Public source category; null or empty when no value is exposed.

addressstringnullable

Public source address; null or empty when no value is exposed.

emailstringnullable

Public source email; null or empty when no value is exposed.

linksJSON[]

Public source links; null or empty when no value is exposed.

phonestringnullable

Public source phone; null or empty when no value is exposed.

websitestringnullable

Public source website; null or empty when no value is exposed.

servicesstringnullable

Public source services; null or empty when no value is exposed.

priceRangestringnullable

Public source priceRange; null or empty when no value is exposed.

ratingstringnullable

Public source rating; null or empty when no value is exposed.

ratingCountnumbernullable

Public source ratingCount; null or empty when no value is exposed.

likeCountnumbernullable

Public source likeCount; null or empty when no value is exposed.

talkingAboutCountnumbernullable

Public source talkingAboutCount; null or empty when no value is exposed.

followerCountnumbernullable

Public source followerCount; null or empty when no value is exposed.

businessHoursobject[]nullableoptional

Optional.

dataobjectoptional

Normalized result with author, post, event or listing data and per-item coverage where applicable.

When include is requested: total rows, successfully enriched rows and failed rows.

hydration.totalinteger

Always included.

hydration.enrichedinteger

Always included.

hydration.failedinteger

Always included.

successboolean

True when usable public data is returned.

statusenum

success or partial on HTTP 200; failed or challenged on failure.

one of: success, partial

requestIdstring

Request correlation UUID.

sourceUrlstring

Canonical public Facebook page used for retrieval.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Completeness of this bounded response. Warnings name restricted, missing, interrupted or unavailable optional data.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Counted upstream requests, decoded response bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsinteger

Always included.

≥ 0

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
200	`partial`	Usable data with explicit missing/failed auxiliary coverage.
400	`invalid_request`	Malformed, duplicate, conflicting or unsupported parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The resource is private or restricted.
404	`not_found`	Unknown route or missing resource.
429	`upstream_rate_limited`	Facebook throttled retrieval.
502	`upstream_challenged` `upstream_error` `unsupported_page`	Source challenge, failure or unsupported/mismatched structure.
502	`response_too_large` `payload_too_complex` `request_limit` `unsafe_redirect`	Bounded retrieval or fixed-origin policy failed.
503	`busy`	All Facebook worker slots are occupied.
504	`timeout`	Request deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/facebook/profile?url=https%3A%2F%2Fwww.facebook.com%2Fsynthetic.page%2F" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/facebook/profile?url=https%3A%2F%2Fwww.facebook.com%2Fsynthetic.page%2F",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/facebook/profile?url=https%3A%2F%2Fwww.facebook.com%2Fsynthetic.page%2F",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Facebook request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/facebook/profile",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.facebook.com/synthetic.page/"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/facebook/profile?url=https%3A%2F%2Fwww.facebook.com%2Fsynthetic.page%2F", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/facebook/profile?url=https%3A%2F%2Fwww.facebook.com%2Fsynthetic.page%2F"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "adLibrary": null,
  "creationDate": null,
  "id": "100000000000001",
  "name": "Synthetic name",
  "url": "https://www.facebook.com/synthetic.page/",
  "gender": null,
  "coverPhoto": null,
  "isBusinessPageActive": null,
  "profilePhoto": null,
  "profilePicLarge": null,
  "profilePicMedium": null,
  "profilePicSmall": null,
  "pageIntro": null,
  "category": null,
  "address": null,
  "email": null,
  "links": [],
  "phone": null,
  "website": null,
  "services": null,
  "priceRange": null,
  "rating": null,
  "ratingCount": null,
  "likeCount": null,
  "talkingAboutCount": null,
  "followerCount": null,
  "success": true,
  "status": "partial",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://www.facebook.com/synthetic.page/",
  "fetchedAt": "2026-09-12T00:00:00.000Z",
  "coverage": {
    "source": "public_web",
    "complete": false,
    "warnings": [
      "synthetic_example"
    ]
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 1200,
    "durationMs": 500
  }
}

Malformed, duplicate, conflicting or unsupported parameters.

{
  "success": false,
  "status": "failed",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  }
}