Skip to content
scrapeatlas.Dashboard

Get company ads

Try in Playground

Retrieve public advertiser suggestions or one page of an advertiser’s ads. Company-name lookup requires a unique exact match; use pageId when ambiguous.

GET/v1/facebook/adLibrary/company/adsx-api-key
x-api-keystringrequiredheader

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

Query parameters
11
pageIdstringquery

Exact numeric advertiser page ID. Use pageId or companyName.

Example99887766
companyNamestringquery

Requires exactly one case-insensitive exact advertiser-name match. Prefer pageId to avoid ambiguity.

min 1 chars · max 4096 chars

countrystringdefault: "ALL"query

Two uppercase letters or ALL. Defaults to ALL.

default: "ALL"

statusenumdefault: "ACTIVE"query

Query filter: ACTIVE (default), INACTIVE or ALL. Response: success, partial, failed or challenged.

one of: ALL, ACTIVE, INACTIVE · default: "ACTIVE"

media_typeenumdefault: "ALL"query

ALL (default), IMAGE, VIDEO, MEME, IMAGE_AND_MEME or NONE.

one of: ALL, IMAGE, VIDEO, MEME, IMAGE_AND_MEME, NONE · default: "ALL"

sort_byenumdefault: "total_impressions"query

total_impressions (default) or relevancy_monthly_grouped.

one of: total_impressions, relevancy_monthly_grouped · default: "total_impressions"

languagestringquery

Optional two-letter content language.

start_datestringquery

Optional real calendar date YYYY-MM-DD.

end_datestringquery

Optional real calendar date YYYY-MM-DD, on or after start_date.

trimenumquery

Use the compact field projection while preserving creative snapshots and regional transparency.

one of: true, false

cursorstringquery

Opaque continuation token bound to the operation and filters. POST supports long cursor values.

min 1 chars · max 65536 chars

Response fields
30
successboolean

Whether usable public data was retrieved.

statusenum

Query filter: ACTIVE (default), INACTIVE or ALL. Response: success, partial, failed or challenged.

one of: success, partial

requestIdstring

Request correlation ID.

sourceUrlstring

Canonical public library URL.

absolute HTTPS URL

fetchedAtstring

UTC retrieval time.

Completeness of the bounded source result, with explicit auxiliary-data warnings.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

Upstream requests, decoded response bytes and elapsed milliseconds. Page 1 includes browser bootstrap traffic; a warm continuation is one GraphQL POST.

accounting.upstreamRequestsinteger

Always included.

0 – 100

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

Company ad records. ads remains a service alias.

up to 100 items

results.ad_archive_idstring

Always included.

results.page_idstring

Always included.

results.is_activeboolean

Always included.

results.snapshotobject

Always included.

Source ad records with exact archive/page IDs, public creative snapshots, cards, images/videos, publisher platforms, dates and available counts. Unknown source values remain null.

up to 100 items

ads.ad_archive_idstring

Always included.

ads.page_idstring

Always included.

ads.is_activeboolean

Always included.

ads.snapshotobject

Always included.

Source ad records for keyword searches; advertiser suggestions for company search. ads is also retained as a service alias.

up to 100 items

searchResults.ad_archive_idstring

Always included.

searchResults.page_idstring

Always included.

searchResults.is_activeboolean

Always included.

searchResults.snapshotobject

Always included.

cursorstringnullable

Opaque continuation token bound to the operation and filters. POST supports long cursor values.

searchResultsCountnumbernullable

Source total estimate when available, otherwise null.

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
12
HTTPfailure.codeMeaning
400invalid_requestInvalid, conflicting or unsupported parameters/cursor.
401unauthorizedMissing or invalid x-api-key.
403restricted_pageSource marks the ad restricted.
404not_foundExplicitly absent ad or no exact company match.
429upstream_rate_limitedMeta rate limit after at most two fresh proxy-session retries; direct egress is never retried on the same IP.
502upstream_error upstream_challenged unsupported_pageSource failed, challenged, or returned unsupported data.
502response_too_large request_limit payload_too_complexAn operation bound was exceeded.
503busyBoth retrieval slots are occupied.
504timeoutThe operation deadline expired.
503transcription_unavailableLocal speech runtime is not configured.
502transcription_failedMedia decoding or speech recognition failed.
422transcription_too_longVideo exceeds the 180-second speech limit.