/facebook/ads

POST /api/facebook/ads

Price: 5 credits

Get a Facebook Ad Library ad by Library ID

How to use it

Get one Facebook Ad Library (facebook.com/ads/library) ad by its Library ID. Accepts a numeric Library ID (e.g. '1677230640306960') or a full Ad Library URL containing '?id=<library_id>'. Returns id, url, advertiser, creatives (image/video/cards), text, title, cta, started_at, platforms, country. For political/issue ads also returns currency, spend_range, reach_estimate, impressions_range, fev_info.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• ad string required — Library ID of the ad, or a Facebook Ad Library URL containing `?id=<library_id>` (examples: "1677230640306960", "https://www.facebook.com/ads/library/?id=1677230640306960"; minLength: 1)

Response

• @type string (default: "FacebookAd")
• id string required
• url string required
• is_active boolean (default: false)
• started_at integer nullable
• ended_at integer nullable
• platforms array (default: [])
• country string nullable
• categories array (default: [])
• collation_count integer nullable
• advertiser object nullable
  • @type string (default: "FacebookAdvertiser")
  • id string required
  • name string nullable
  • alias string nullable
  • image string nullable
  • categories array (default: [])
  • like_count integer nullable
  • byline string nullable
  • is_deleted boolean (default: false)
• creatives array (default: [])
  • @type string (default: "FacebookAdCreative")
  • image string nullable
  • image_resized string nullable
  • video string nullable
  • video_preview string nullable
  • cards array (default: [])
    • @type string (default: "FacebookAdCard")
    • text string nullable
    • caption string nullable
    • image string nullable
    • video string nullable
    • video_preview string nullable
    • link_url string nullable
    • link_description string nullable
    • cta_text string nullable
    • cta_type string nullable
• text string nullable
• caption string nullable
• cta_text string nullable
• cta_type string nullable
• link_url string nullable
• link_description string nullable
• display_format string nullable
• is_reshared boolean (default: false)
• contains_sensitive_content boolean (default: false)
• total_active_time integer nullable
• branded_content object nullable
• additional_info object nullable
• currency string nullable
• spend_range string nullable
• reach_estimate string nullable
• impressions_range string nullable
• disclaimer_label string nullable
• fev_info object nullable
  • @type string (default: "FacebookAdFevInfo")
  • authorized_entity_text string nullable
  • submitted_on string nullable
  • phone string nullable
  • email string nullable
  • website string nullable
  • address string nullable
  • additional_info object nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Ad not found. Verify the Library ID. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.