SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

Facebook Ad Library ad transcript

Beta GET /v1/facebook/ad-library/ad/transcript

GET /v1/facebook/ad-library/ad/transcript

Transcript of a video ad. Ad Library videos carry no caption tracks, so this is always AI transcription of the audio, billed by the length of the audio. An ad with no video answers an unbilled error.

  • Cost: 1 credit for captions; AI transcription 1 up to 2 minutes, then 1 per started minute
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
idstringone ofAd id in the library. Also accepted as ad_id, adId.
urlURLone ofAd Library URL (facebook.com/ads/library/?id=...). Accepted hosts: facebook.com.

Send at least one of id, url. If you send several, the first listed is used and the rest are ignored.

Every request also accepts:

  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

curl
curl -G "https://api.socialscrape.io/v1/facebook/ad-library/ad/transcript" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "id=352695862528588"
Python
import os
import requests

params = {
    "id": "352695862528588",
}
res = requests.get(
    "https://api.socialscrape.io/v1/facebook/ad-library/ad/transcript",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
    params=params,
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const url = new URL("https://api.socialscrape.io/v1/facebook/ad-library/ad/transcript");
url.search = new URLSearchParams({
  "id": "352695862528588"
}).toString();
const res = await fetch(url, {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape Facebook Ad Library ad transcript",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/facebook/ad-library/ad/transcript",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            {
              "name": "id",
              "value": "352695862528588"
            }
          ]
        },
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

Example response#

This is a sample from a recorded response. Status 200.

{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_63eae290249d0c81df4c4ff3",
  "data": {
    "object": "transcript",
    "platform": "facebook",
    "video_id": "352695862528588",
    "url": "https://www.facebook.com/ads/library/?id=352695862528588",
    "language": "en",
    "source": "ai",
    "duration_seconds": 30.0,
    "text": "canned transcript for the fixture, not the ad's real audio",
    "segments": [
      {
        "start": 0.0,
        "end": 4.0,
        "text": "canned transcript for the fixture,"
      },
      {
        "start": 4.0,
        "end": 30.0,
        "text": "not the ad's real audio"
      }
    ],
    "available_languages": null,
    "extra": {
      "media_seconds": 30.0
    }
  },
  "cursor": null,
  "has_more": null
}

Response#

A Transcript object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.
transcript_unavailable404noNo captions exist and AI transcription is not possible for this media.

Every request can also fail with the account and platform errors listed on the Errors page.

Also served at#

These paths answer the same request, so code written for other APIs keeps working: /v1/facebook/adLibrary/ad/transcript. See Switching from ScrapeCreators.