Facebook Ad Library

Facebook Ad Library Advertiser Search API

Returns the advertisers in Meta's public Ad Library that match a name, username or Page ID, as its search box suggests them. Each has its Page ID (the ID its ads are filed under), name, username, picture, category, country, verified badge and exact follower count, plus the Instagram account Meta links to it with that account's exact followers and badge. Send a country to rank the matches for it.

GET /v1/facebook/search_advertisers

Try it

Example

cURL
curl 'https://socialtap.dev/v1/facebook/search_advertisers?query=baileys' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.facebook.searchAdvertisers.list({ query: "baileys" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  query: "baileys",
});
const res = await fetch(`https://socialtap.dev/v1/facebook/search_advertisers?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
Python (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/facebook/search_advertisers",
    params={"query": "baileys"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
Go (net/http)
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("query", "baileys")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/facebook/search_advertisers?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
PHP
<?php

$query = http_build_query([
    'query' => 'baileys',
]);
$ch = curl_init('https://socialtap.dev/v1/facebook/search_advertisers?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/facebook/search_advertisers")
uri.query = URI.encode_www_form('query' => 'baileys')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "query=" + encode("baileys");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/facebook/search_advertisers?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "query=" + Uri.EscapeDataString("baileys"));
var res = await http.GetAsync("https://socialtap.dev/v1/facebook/search_advertisers?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/facebook/search_advertisers")
        .query(&[("query", "baileys")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": [
    {
      "approximate_fields": [],
      "avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.30808-1/443711959_876169351217288_8358221437311147045_n.jpg?stp=dst-jpg_s200x200_tt6&_nc_cat=110&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_nc_ss=7b289&oh=SCRUBBED…",
      "banner_url": null,
      "bio": null,
      "category": "Wine/spirits",
      "country_code": null,
      "created_at": null,
      "display_name": "Baileys",
      "external_links": [],
      "id": "73939360594",
      "is_private": null,
      "is_verified": true,
      "location": null,
      "metrics": {
        "follower_count": 4664402,
        "following_count": null,
        "post_count": null,
        "total_like_count": null,
        "total_view_count": null
      },
      "platform": "facebook",
      "platform_specific": {
        "facebook": {
          "ad_library_entity_type": "PERSON_PROFILE",
          "admin_countries": [],
          "alternate_name": null,
          "business_hours": [],
          "education": [],
          "email": null,
          "gender": null,
          "hometown": null,
          "hours_status": null,
          "instagram_follower_count": 248872,
          "instagram_username": "baileysofficial",
          "is_deleted": false,
          "is_instagram_verified": true,
          "is_memorialized": null,
          "is_political_advertiser": null,
          "is_running_ads": null,
          "name_changes": [],
          "owner_location": null,
          "owner_name": null,
          "page_id": "73939360594",
          "phone": null,
          "price_range": null,
          "rating": null,
          "recommend_percent": null,
          "relationship": null,
          "review_count": null,
          "services": [],
          "talking_about_count": null,
          "were_here_count": null,
          "work": []
        }
      },
      "type": "unknown",
      "unknown_fields": [
        "external_links",
        "platform_specific.facebook.services",
        "platform_specific.facebook.business_hours"
      ],
      "url": "https://www.facebook.com/Baileys",
      "username": "Baileys"
    },
    {
      "approximate_fields": [],
      "avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.30808-1/445756898_874337388053755_8139191371735594555_n.jpg?stp=dst-jpg_s200x200_tt6&_nc_cat=109&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_nc_ss=7b289&oh=SCRUBBED…",
      "banner_url": null,
      "bio": null,
      "category": "Wine/spirits",
      "country_code": "GB",
      "created_at": null,
      "display_name": "Baileys",
      "external_links": [],
      "id": "151277918233754",
      "is_private": null,
      "is_verified": true,
      "location": null,
      "metrics": {
        "follower_count": 4664402,
        "following_count": null,
        "post_count": null,
        "total_like_count": null,
        "total_view_count": null
      },
      "platform": "facebook",
      "platform_specific": {
        "facebook": {
          "ad_library_entity_type": "PERSON_PROFILE",
          "admin_countries": [],
          "alternate_name": null,
          "business_hours": [],
          "education": [],
          "email": null,
          "gender": null,
          "hometown": null,
          "hours_status": null,
          "instagram_follower_count": null,
          "instagram_username": null,
          "is_deleted": false,
          "is_instagram_verified": null,
          "is_memorialized": null,
          "is_political_advertiser": null,
          "is_running_ads": null,
          "name_changes": [],
          "owner_location": null,
          "owner_name": null,
          "page_id": "151277918233754",
          "phone": null,
          "price_range": null,
          "rating": null,
          "recommend_percent": null,
          "relationship": null,
          "review_count": null,
          "services": [],
          "talking_about_count": null,
          "were_here_count": null,
          "work": []
        }
      },
      "type": "unknown",
      "unknown_fields": [
        "external_links",
        "platform_specific.facebook.services",
        "platform_specific.facebook.business_hours"
      ],
      "url": "https://www.facebook.com/BaileysGB",
      "username": "BaileysGB"
    },
    {
      "approximate_fields": [],
      "avatar_url": "https://scontent-atl3-2.xx.fbcdn.net/v/t39.30808-1/884884889_1163136826368298_466053757919124974_n.avif?stp=dst-avif_s200x200&_nc_cat=104&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-2.xx&_nc_gid=SCRUBBED&_nc_ss=7b289&oh=SCRUBBED&o…",
      "banner_url": null,
      "bio": null,
      "category": "Wine/spirits",
      "country_code": "US",
      "created_at": null,
      "display_name": "Baileys",
      "external_links": [],
      "id": "109408419132021",
      "is_private": null,
      "is_verified": true,
      "location": null,
      "metrics": {
        "follower_count": 4664402,
        "following_count": null,
        "post_count": null,
        "total_like_count": null,
        "total_view_count": null
      },
      "platform": "facebook",
      "platform_specific": {
        "facebook": {
          "ad_library_entity_type": "PERSON_PROFILE",
          "admin_countries": [],
          "alternate_name": null,
          "business_hours": [],
          "education": [],
          "email": null,
          "gender": null,
          "hometown": null,
          "hours_status": null,
          "instagram_follower_count": 149344,
          "instagram_username": "baileysus",
          "is_deleted": false,
          "is_instagram_verified": true,
          "is_memorialized": null,
          "is_political_advertiser": null,
          "is_running_ads": null,
          "name_changes": [],
          "owner_location": null,
          "owner_name": null,
          "page_id": "109408419132021",
          "phone": null,
          "price_range": null,
          "rating": null,
          "recommend_percent": null,
          "relationship": null,
          "review_count": null,
          "services": [],
          "talking_about_count": null,
          "were_here_count": null,
          "work": []
        }
      },
      "type": "unknown",
      "unknown_fields": [
        "external_links",
        "platform_specific.facebook.services",
        "platform_specific.facebook.business_hours"
      ],
      "url": "https://www.facebook.com/baileysus",
      "username": "baileysus"
    }
  ],
  "page": {
    "has_more": false,
    "next_cursor": null,
    "next_cursor_expires_at": null,
    "end_reason": "platform_limit"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "facebook",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 434,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": null,
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

x-api-keystringheaderrequired

Your API key. Authentication

querystringrequiredmax 200 chars

An advertiser's name or part of it, its Facebook username or its Page ID (never its profile ID), as typed into the Ad Library's search box, in any language (baileys, コカ・コーラ, 20531316728).

Examplebaileys

countrystringiso3166-1-alpha-2

Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive). The country to search from: Meta ranks the matches for it, and an advertiser from elsewhere can still appear. An ISO 3166-1 alpha-2 code such as US. Every country when omitted.

ExampleUS

limitintegermin 1max 15

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example15

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts
max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, page, meta}. data is an array of up to 15 profile objects, the search box's own order; page says how to get the next page; meta describes the request (meta). Fields only Facebook Ad Library has are under platform_specific.facebook.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native account ID (string; YouTube UC…, Reddit t2_…).

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name, channel title or page name; null when empty or not exposed.

urlstring uri

Canonical profile URL.

typestring

Coarse account kind, as the platform labels it; unknown when it does not (TikTok labels organizations only). New values may be added; treat unknown values as unknown.

One ofpersonorganizationcommunityunknown

biostringnullable

Profile bio, channel description or page about text; null when empty or not exposed.

avatar_urlstring urinullable

Profile picture URL (largest available). Platform CDN URLs can expire within hours.

banner_urlstring urinullable

Header or cover image URL.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

is_privatebooleannullable

True when the account's posts are not public.

categorystringnullable

Platform category label (e.g. Musician, Media & Entertainment), as shown; not normalized. Often set only for business or creator accounts.

external_linksobject[]

Links in the bio or channel links; [] if none or not exposed.

ShowHide 2 child fields
urlstring uri

Link target, absolute (https:// is added where the platform stores the link without a scheme).

titlestringnullable

Link label shown by the platform.

locationstringnullable

Self-declared location text.

country_codestringnullable

ISO 3166-1 alpha-2 country the platform states for the account.

created_atstring date-timenullable

Account creation or join date, RFC 3339 UTC (some platforms give only the day: see approximate_fields).

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 5 child fields
follower_countintegernullable

Followers or subscribers.

following_countintegernullable

Accounts this profile follows.

post_countintegernullable

Posts or videos as the platform counts them on the profile (for a private account, posts the caller cannot see).

total_like_countintegernullable

Likes received across all of the profile's posts (not likes given).

total_view_countintegernullable

Lifetime views across all of the profile's posts.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
facebookobjectnullable

A Facebook Page's or person's own fields.

ShowHide 30 child fields
page_idstringnullable

The Page ID Facebook shows under Page transparency, which is also the advertiser's ID in Meta's Ad Library; null for an account without one (most people's profiles).

genderstringnullable

A person's gender as Facebook states it, male or female; null for a Page or when it states none.

alternate_namestringnullable

The other name the account shows beside its name.

is_memorializedbooleannullable

True for a memorialized account ("Remembering …").

talking_about_countintegernullable

How many people Facebook counts as talking about the account. It is shown only on the profile's own page, which most requests are answered without: null when this answer did not read it.

were_here_countintegernullable

How many people have checked in at a place's Page. It is shown only on the profile's own page, which most requests are answered without: null when this answer did not read it, or for an account that is not a place.

emailstringnullable

The public contact email the profile shows.

phonestringnullable

The public contact phone number the profile shows, as written there.

price_rangestringnullable

A business's price range as shown, such as $$.

ratingstringnullable

The rating line as shown, such as 96% recommend (1,121 reviews).

recommend_percentintegernullable

The share of reviewers who recommend the Page, as a percentage; null when it is not yet rated.

review_countintegernullable

How many reviews the Page has.

servicesstring[]

What the business offers, as Facebook lists it (Delivery, Takeout, Dine-in). [] when it lists none.

hours_statusstringnullable

Whether the business is open at fetch time, in Facebook's words (Open now, Closed now, Closing soon).

business_hoursobject[]

A business's weekly opening hours, a day at a time. [] when it shows none.

ShowHide 3 child fields
daystringnullable

The day of the week, as Facebook names it (Monday).

hoursstringnullable

The day's hours as shown, such as 11:00 AM - 2:30 PM, 4:30 PM - 9:30 PM, or Closed.

periodsobject[]

The same hours as 24-hour times, one per opening; [] on a closed day or when the text is not a list of times.

ShowHide 2 child fields
openstring

Opening time, 24-hour HH:MM, local to the business.

closestring

Closing time, 24-hour HH:MM, local to the business.

workstring[]

The jobs a person's intro lists, as written there (Founder and CEO at Meta). [] when it lists none.

educationstring[]

The schools a person's intro lists, as written there. [] when it lists none.

hometownstringnullable

The hometown a person's intro states.

relationshipstringnullable

The relationship a person's intro states, as written there.

owner_namestringnullable

The organization or person Facebook confirms is responsible for the Page.

owner_locationstringnullable

The confirmed owner's location, as Page transparency states it.

is_running_adsbooleannullable

True when the account is running ads now (Page transparency).

is_political_advertiserbooleannullable

True when the account has run ads about social issues, elections or politics.

admin_countriesobject[]

Where the people who manage the Page are, as Page transparency counts them. [] when it shows none.

ShowHide 2 child fields
countrystringnullable

The country's name.

countintegernullable

How many of the Page's admins are there.

name_changesobject[]

The Page's earlier name changes, newest first. [] when it has none.

ShowHide 2 child fields
namestring

The name it took.

changed_atstring date-time

When it changed, RFC 3339 UTC.

instagram_usernamestringnullable

The Instagram account Meta links to the advertiser, as its Ad Library's advertiser search shows it; null when it links none or for a profile read from elsewhere.

instagram_follower_countintegernullable

That Instagram account's exact followers, as the Ad Library's advertiser search shows them.

is_instagram_verifiedbooleannullable

Whether that Instagram account has the verified badge, as the Ad Library's advertiser search shows it.

is_deletedbooleannullable

True when the Page has been deleted, as the Ad Library's advertiser search states it: its ads stay in the library. Null for a profile read from elsewhere.

ad_library_entity_typestringnullable

Meta's own label for the advertiser in its Ad Library, as written there (PERSON_PROFILE, REGULAR_PAGE, IG_ADS_IDENTITY for an advertiser that exists only on Instagram). It labels brands PERSON_PROFILE too: it says how Meta files the advertiser, not what it is. New values may appear. Null for a profile read from elsewhere.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.follower_count). A list path (external_links) means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 2 error codes. Free: errors cost nothing.

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Items come in pages, the search box's own order. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order
The search box's own order
Page size
Up to 15 advertisers (the default; limit lowers it)
Cursor lifetime
24 hours; don't store cursors
Price
Per page, 1 credit

The page object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

Next page

cURL: next page
curl 'https://socialtap.dev/v1/facebook/search_advertisers?query=baileys&cursor=NEXT_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
  • The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
  • A limit below 15 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
  • Errors are free, including a rejected cursor.
  • Pages served from the cache are free.
  • An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source.

SourcePrice per successful pagePer 1,000 pages
Platform API api1 credit$0.75–$1.97
Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
apiPlatform APIThe platform's public, logged-out API.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID facebook.search_advertisers · operationId facebook.search_advertisers.list · Product overview

Last updated