Skip to content

Structured Facebook data: send urls. Cursor-paginated, 1 credit per successful call.

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/facebook-ad-library/Open in Playground

Call GET /api/v2/facebook-ad-library/ with urls. The results are in data.ads; send data.next_cursor back as cursor to get the next page. 8 optional parameters refine the call (see Parameters).

Terminal window
curl -G "https://api.scrapier.io/api/v2/facebook-ad-library/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "urls=https://www.facebook.com/ZapierApp" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
urlsstringyese.g. https://www.facebook.com/ZapierAppFacebook Ad Library URL (search or page)
cursorstringno—Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page.
ad_countrystringnoALLCountry filter.
locked in cursor
ad_typestringnoallAd type filter, lowercase (e.g. 'all', 'political_and_issue_ads') -- Facebook's URL route is case-sensitive; 'ALL' uppercase silently narrows results.
locked in cursor
ad_statusstringnoALLActive / Inactive / ALL.
locked in cursor
scrape_detailsbooleannofalseFetch full ad details per item (slower).
locked in cursor
countrystringnoALLDefault country code (e.g., ALL, US, IN)
periodstringno—Facebook date_preset filter (e.g., ALL, LAST_30_DAYS) — leave empty to use URL default
active_statusstringnoallAd activity filter: all, active, or inactive
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes.
{
"success": true,
"data": {
"urls": "https://www.facebook.com/ads/library/?q=covid",
"page": 1,
"page_size": 10,
"ads": [
{
"id": "ad-1",
"ad_archive_id": "1234567890",
"page_name": "Example",
"ad_text": "..."
}
],
"next_cursor": "eyJpIjoidXJsIiwicCI6Mn0"
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.ads.

FieldTypeExampleDescription
urlsstringhttps://www.facebook.com/ads/library/?q=covid—
pageinteger1—
page_sizeinteger10—
adsarray[1 item]The results.
next_cursorstringeyJpIjoidXJsIiwicCI6Mn0Pass back as cursor for the next page. null on the last page.
ads[].idstringad-1—
ads[].ad_archive_idstring1234567890—
ads[].page_namestringExample—
ads[].ad_textstring...—

Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.

const url = "https://api.scrapier.io/api/v2/facebook-ad-library/";
let params = { urls: "https://www.facebook.com/ZapierApp" };
const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call
const res = await fetch(`${url}?${new URLSearchParams(params)}`, {
headers: { "X-API-Key": "YOUR_API_KEY" },
signal: AbortSignal.timeout(210_000),
});
const body = await res.json();
if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
const data = body.data;
items.push(...(data.ads ?? []));
if (!data.next_cursor) break; // null = last page
params = { cursor: data.next_cursor };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • Locked into the cursor: ad_country, ad_type, ad_status, scrape_details. Set them on the first call; later pages reuse them.