Ad details

Try in Playground

Retrieve an ad with creative variants, payer and beneficiary information, and EU, UK or Brazil transparency. Set includeTranscript=true to transcribe its primary video.

GET/v1/facebook/adLibrary/adx-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

idstringquery

Exact numeric archive ID, supplied as a string. Use id or url, not both.

Example123456789012345678

urlstringquery

Canonical HTTPS facebook.com/ads/library/?id= URL.

max 4096 chars

trimenumquery

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

one of: true, false

includeTranscriptenumquery

Recognize speech in the first available primary or carousel video. Requires configured local Whisper and FFmpeg.

one of: true, false

cache_max_ageenumquery

Accepted freshness hint; every response is fetched live and returns cached=false.

one of: 1d, 3d, 7d, 14d, 30d

Response fields

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

adArchiveIDstring

Exact archive ID as a string.

pageIDstring

Advertiser page ID as a string.

isActiveboolean

Source active status.

snapshotobject

Creative fields and every returned carousel card; card titles can differ from the main title.

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
400	`invalid_request`	Invalid, conflicting or unsupported parameters/cursor.
401	`unauthorized`	Missing or invalid x-api-key.
403	`restricted_page`	Source marks the ad restricted.
404	`not_found`	Explicitly absent ad or no exact company match.
429	`upstream_rate_limited`	Meta rate limit after at most two fresh proxy-session retries; direct egress is never retried on the same IP.
502	`upstream_error` `upstream_challenged` `unsupported_page`	Source failed, challenged, or returned unsupported data.
502	`response_too_large` `request_limit` `payload_too_complex`	An operation bound was exceeded.
503	`busy`	Both retrieval slots are occupied.
504	`timeout`	The operation deadline expired.
503	`transcription_unavailable`	Local speech runtime is not configured.
502	`transcription_failed`	Media decoding or speech recognition failed.
422	`transcription_too_long`	Video exceeds the 180-second speech limit.

Code example

curl "https://api.scrapeatlas.com/v1/facebook/adLibrary/ad?id=123456789012345678" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/facebook/adLibrary/ad?id=123456789012345678",
  {
    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/adLibrary/ad?id=123456789012345678",
  {
    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(`Meta Ads Library request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/facebook/adLibrary/ad",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "id": "123456789012345678"
    },
    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/adLibrary/ad?id=123456789012345678", 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/adLibrary/ad?id=123456789012345678"))
            .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.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://www.facebook.com/ads/library/",
  "fetchedAt": "2026-09-11T00:00:00.000Z",
  "coverage": {
    "source": "public_browser",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 24,
    "responseBytes": 11000000,
    "durationMs": 2800
  },
  "adArchiveID": "123456789012345678",
  "pageID": "99887766",
  "isActive": true,
  "snapshot": {
    "body": {
      "text": "Synthetic ad copy"
    },
    "cards": [
      {
        "title": "Creative variant",
        "link_url": "https://example.com"
      }
    ],
    "images": [],
    "videos": []
  },
  "aaa_info": {
    "targets_eu": true,
    "payer_beneficiary_data": [
      {
        "payer": "Synthetic advertiser",
        "beneficiary": "Synthetic advertiser"
      }
    ],
    "total_reach": 250
  }
}

Invalid, conflicting or unsupported parameters/cursor.

{
  "success": false,
  "status": "failed",
  "requestId": "string",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}