Get an API key; the examples use
api.socialscrape.dev.Before you start
- An API key, sent in the
x-api-keyheader. Keep it on your server. - For this endpoint you send one of
idorcompany_name. The Facebook Ad Library ads by page page lists every parameter.
Step 1: Send the request
GET /v1/facebook/ad-library/company/ads. Pick your language; each one reads the key from SOCIALSCRAPE_API_KEY.
1curl -G "https://api.socialscrape.dev/v1/facebook/ad-library/company/ads" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3 --data-urlencode 'id=15087023444' \4 --data-urlencode 'region=US'1import os2import requests34params = {5 "id": "15087023444",6 "region": "US",7}8res = requests.get(9 "https://api.socialscrape.dev/v1/facebook/ad-library/company/ads",10 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},11 params=params,12 timeout=60,13)14body = res.json()1516if body["ok"]:17 print(body["data"])18else:19 print(body["error"]["code"], body["error"]["message"])1const url = new URL("https://api.socialscrape.dev/v1/facebook/ad-library/company/ads");2url.search = new URLSearchParams({3 id: "15087023444",4 region: "US",5}).toString();6const res = await fetch(url, {7 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY },8});9const body = await res.json();1011if (body.ok) {12 console.log(body.data);13} else {14 console.error(body.error.code, body.error.message);15}1const url = new URL("https://api.socialscrape.dev/v1/facebook/ad-library/company/ads");2url.search = new URLSearchParams({3 id: "15087023444",4 region: "US",5}).toString();6const res = await fetch(url, {7 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },8});9const body = await res.json();1011if (body.ok) {12 console.log(body.data);13} else {14 console.error(body.error.code, body.error.message);15}1package main23import (4 "fmt"5 "io"6 "net/http"7 "net/url"8 "os"9)1011func main() {12 q := url.Values{}13 q.Set("id", "15087023444")14 q.Set("region", "US")15 req, _ := http.NewRequest("GET", "https://api.socialscrape.dev/v1/facebook/ad-library/company/ads" + "?" + q.Encode(), nil)16 req.Header.Set("x-api-key", os.Getenv("SOCIALSCRAPE_API_KEY"))17 res, err := http.DefaultClient.Do(req)18 if err != nil {19 panic(err)20 }21 defer res.Body.Close()22 body, _ := io.ReadAll(res.Body)23 fmt.Println(res.StatusCode, string(body))24}1<?php2$query = http_build_query([3 'id' => '15087023444',4 'region' => 'US',5]);6$ch = curl_init('https://api.socialscrape.dev/v1/facebook/ad-library/company/ads' . "?" . $query);7curl_setopt_array($ch, [8 CURLOPT_RETURNTRANSFER => true,9 CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("SOCIALSCRAPE_API_KEY")],10]);11$body = json_decode(curl_exec($ch), true);12curl_close($ch);1314if ($body["ok"]) {15 print_r($body["data"]);16} else {17 echo $body["error"]["code"], " ", $body["error"]["message"], "\n";18}1require "net/http"2require "json"34uri = URI('https://api.socialscrape.dev/v1/facebook/ad-library/company/ads')5uri.query = URI.encode_www_form('id' => '15087023444', 'region' => 'US')6req = Net::HTTP::Get.new(uri)7req["x-api-key"] = ENV.fetch("SOCIALSCRAPE_API_KEY")8res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }9body = JSON.parse(res.body)1011if body["ok"]12 puts body["data"]13else14 puts body["error"]["code"], body["error"]["message"]15end1import java.net.URI;2import java.net.URLEncoder;3import java.net.http.HttpClient;4import java.net.http.HttpRequest;5import java.net.http.HttpResponse;6import java.nio.charset.StandardCharsets;78public class Main {9 public static void main(String[] args) throws Exception {10 String query = "id=" + URLEncoder.encode("15087023444", StandardCharsets.UTF_8) + "®ion=" + URLEncoder.encode("US", StandardCharsets.UTF_8);11 HttpRequest req = HttpRequest.newBuilder()12 .uri(URI.create("https://api.socialscrape.dev/v1/facebook/ad-library/company/ads" + "?" + query))13 .header("x-api-key", System.getenv("SOCIALSCRAPE_API_KEY"))14 .GET()15 .build();16 HttpResponse<String> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());17 System.out.println(res.statusCode() + " " + res.body());18 }19}1using System;2using System.Net.Http;34var client = new HttpClient();5client.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALSCRAPE_API_KEY"));6var query = string.Join("&", new[] {7 "id=" + Uri.EscapeDataString("15087023444"),8 "region=" + Uri.EscapeDataString("US"),9});10var res = await client.GetAsync("https://api.socialscrape.dev/v1/facebook/ad-library/company/ads" + "?" + query);11Console.WriteLine((int)res.StatusCode);12Console.WriteLine(await res.Content.ReadAsStringAsync());Step 2: Read the response
Results are in data.items. Here is what one item gives you, from a recorded sample.
1for item in body["data"]["items"]:2 print(item["title"])3 print(item["id"])1for (const item of body.data.items) {2 console.log(item.title);3 console.log(item.id);4}SampleFields printed above
1{2 "title": "NikeSKIMS Outerwear",3 "id": "1741150940324450"4}A field the platform does not give comes back as null. The full field list is on the endpoint page.
Step 3: Get the next page
Send the same request with the cursor you got back, until has_more is false. Each page costs its own price.
1import os2import requests34url = "https://api.socialscrape.dev/v1/facebook/ad-library/company/ads"5headers = {"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]}6params = {"id": "15087023444", "region": "US"}78items = []9while len(items) < 100:10 body = requests.get(url, headers=headers, params=params, timeout=60).json()11 if not body["ok"]:12 raise RuntimeError(body["error"]["code"])13 items += body["data"]["items"]14 if not body["has_more"]:15 break16 params["cursor"] = body["cursor"]1718print(len(items), "items")1const url = new URL("https://api.socialscrape.dev/v1/facebook/ad-library/company/ads");2url.searchParams.set("id", "15087023444");3url.searchParams.set("region", "US");4const headers = { "x-api-key": process.env.SOCIALSCRAPE_API_KEY };56const items = [];7while (items.length < 100) {8 const body = await (await fetch(url, { headers })).json();9 if (!body.ok) throw new Error(body.error.code);10 items.push(...body.data.items);11 if (!body.has_more) break;12 url.searchParams.set("cursor", body.cursor);13}1415console.log(items.length, "items");Step 4: Handle errors
Check ok, then branch on error.code and error.retryable, never on the message.
1body = res.json()2if not body["ok"]:3 err = body["error"]4 if err["retryable"]:5 ... # wait a moment and send the same request again6 else:7 raise RuntimeError(f'{err["code"]}: {err["message"]}')1const body = await res.json();2if (!body.ok) {3 const { code, message, retryable } = body.error;4 if (retryable) {5 // wait a moment and send the same request again6 } else {7 throw new Error(`${code}: ${message}`);8 }9}| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
not_found | 404 | no | The platform says this profile, post or item does not exist. |
Other errors, such as unauthorized or rate_limited, are on the errors page.
With the SDK
The Python and TypeScript clients wrap all of this: typed errors, retries, and cursor paging. Install them with pip install socialscrape-sdk or npm install socialscrape.
1from socialscrape import SocialScrape23client = SocialScrape() # reads SOCIALSCRAPE_API_KEY45for item in client.paginate(client.facebook.ad_library_company_ads, id="15087023444", region="US", max_items=100):6 print(item["title"])1import { SocialScrape } from "socialscrape";23const client = new SocialScrape(); // reads SOCIALSCRAPE_API_KEY45for await (const item of client.paginate(client.facebook.adLibraryCompanyAds, { id: "15087023444", region: "US" }, { maxItems: 100 })) {6 console.log(item.title);7}What it costs
1 credit. A failed request costs nothing. Add max_age_days to reuse a cached result for 0 credits. Results are kept 30 days.
Next
- Facebook Ad Library ads by page API: sample response and every parameter.
- All Facebook endpoints.