Meta Ads meta Ad API

Scrape a Meta ad's details

curl --request POST \
  --url https://api.stophy.dev/v1/meta/ads/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adUrl": "<string>",
  "adId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({adUrl: '<string>', adId: '<string>'})
};

fetch('https://api.stophy.dev/v1/meta/ads/ad', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/meta/ads/ad"

payload = {
    "adUrl": "<string>",
    "adId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "adUrl": "<string>",
    "pageCategories": [
      "<string>"
    ],
    "isActive": true,
    "platforms": [
      "<string>"
    ],
    "imageUrls": [
      "<string>"
    ],
    "videoUrls": [
      "<string>"
    ],
    "cards": [
      {
        "text": "<string>",
        "linkUrl": "<string>",
        "linkTitle": "<string>",
        "ctaText": "<string>",
        "imageUrl": "<string>",
        "videoUrl": "<string>"
      }
    ],
    "categories": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "audienceAgeGender": [
      {
        "female": 123,
        "male": 123,
        "unknown": 123,
        "age": "<string>"
      }
    ],
    "audienceRegions": [
      {
        "share": 123,
        "region": "<string>"
      }
    ],
    "euReachByCountry": [
      {
        "female": 0,
        "male": 0,
        "unknown": 0,
        "country": "<string>",
        "age": "<string>"
      }
    ],
    "payers": [
      {
        "paidBy": "<string>",
        "beneficiary": "<string>"
      }
    ],
    "adId": "<string>",
    "pageId": "<string>",
    "pageName": "<string>",
    "pageUrl": "<string>",
    "pageAvatarUrl": "<string>",
    "pageLikes": 0,
    "firstShownAt": "2023-11-07T05:31:56Z",
    "lastShownAt": "2023-11-07T05:31:56Z",
    "format": "<string>",
    "text": "<string>",
    "linkUrl": "<string>",
    "linkTitle": "<string>",
    "linkDescription": "<string>",
    "ctaText": "<string>",
    "versions": 0,
    "paidBy": "<string>",
    "spendMin": 0,
    "spendMax": 0,
    "spendCurrency": "<string>",
    "impressionsMin": 0,
    "impressionsMax": 0,
    "reachMin": 0,
    "reachMax": 0,
    "advertiserDescription": "<string>",
    "advertiserCategory": "<string>",
    "advertiserVerification": "<string>",
    "advertiserInstagram": "<string>",
    "advertiserInstagramFollowers": 0,
    "euReachTotal": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

meta

ads

Scrape a Meta ad's details

curl --request POST \
  --url https://api.stophy.dev/v1/meta/ads/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adUrl": "<string>",
  "adId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({adUrl: '<string>', adId: '<string>'})
};

fetch('https://api.stophy.dev/v1/meta/ads/ad', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/meta/ads/ad"

payload = {
    "adUrl": "<string>",
    "adId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "adUrl": "<string>",
    "pageCategories": [
      "<string>"
    ],
    "isActive": true,
    "platforms": [
      "<string>"
    ],
    "imageUrls": [
      "<string>"
    ],
    "videoUrls": [
      "<string>"
    ],
    "cards": [
      {
        "text": "<string>",
        "linkUrl": "<string>",
        "linkTitle": "<string>",
        "ctaText": "<string>",
        "imageUrl": "<string>",
        "videoUrl": "<string>"
      }
    ],
    "categories": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "audienceAgeGender": [
      {
        "female": 123,
        "male": 123,
        "unknown": 123,
        "age": "<string>"
      }
    ],
    "audienceRegions": [
      {
        "share": 123,
        "region": "<string>"
      }
    ],
    "euReachByCountry": [
      {
        "female": 0,
        "male": 0,
        "unknown": 0,
        "country": "<string>",
        "age": "<string>"
      }
    ],
    "payers": [
      {
        "paidBy": "<string>",
        "beneficiary": "<string>"
      }
    ],
    "adId": "<string>",
    "pageId": "<string>",
    "pageName": "<string>",
    "pageUrl": "<string>",
    "pageAvatarUrl": "<string>",
    "pageLikes": 0,
    "firstShownAt": "2023-11-07T05:31:56Z",
    "lastShownAt": "2023-11-07T05:31:56Z",
    "format": "<string>",
    "text": "<string>",
    "linkUrl": "<string>",
    "linkTitle": "<string>",
    "linkDescription": "<string>",
    "ctaText": "<string>",
    "versions": 0,
    "paidBy": "<string>",
    "spendMin": 0,
    "spendMax": 0,
    "spendCurrency": "<string>",
    "impressionsMin": 0,
    "impressionsMax": 0,
    "reachMin": 0,
    "reachMax": 0,
    "advertiserDescription": "<string>",
    "advertiserCategory": "<string>",
    "advertiserVerification": "<string>",
    "advertiserInstagram": "<string>",
    "advertiserInstagramFollowers": 0,
    "euReachTotal": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape a Meta ad’s details. The ad is identified by its URL or ID.

Request

Exactly one of adUrl or adId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.meta.ads.ad({ adUrl: "https://www.facebook.com/ads/library/?id=1234567890123456" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.meta.ads.ad(ad_url="https://www.facebook.com/ads/library/?id=1234567890123456")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/meta/ads/ad \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"adUrl":"https://www.facebook.com/ads/library/?id=1234567890123456"}'

stophy meta ads ad --adUrl "https://www.facebook.com/ads/library/?id=1234567890123456"

Response

If successful, the response body contains the standard envelope. data contains the ad’s page, text, format, platforms and the advertiser’s details. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "adId": "925321173274919",
    "adUrl": "https://www.facebook.com/ads/library/?id=925321173274919",
    "pageId": "89516513179",
    "pageName": "Nordstrom Rack",
    "pageUrl": "https://facebook.com/NordstromRack",
    "pageAvatarUrl": "https://scontent-mia5-1.xx.fbcdn.net/v/t39.35426-6/764807066_1529917005842224_1129201910993892893_n.jpg?stp=dst-jpg_s60…",
    "pageCategories": ["Clothing (Brand)"],
    "pageLikes": 2518828,
    "isActive": true,
    "firstShownAt": "2026-08-03T07:00:00.000Z",
    "platforms": ["facebook"],
    "format": "video",
    "text": "Buy online and pick up in store for free! Get up to 70% off Nike, Vince, Madewell, adidas and more.",
    "linkUrl": "https://fb.com/canvas_doc/1072291375736811",
    "linkTitle": "Fast & Free Pickup",
    "linkDescription": "Fast & Free Pickup",
    "ctaText": "Learn more",
    "videoUrls": ["https://video-mia5-1.xx.fbcdn.net/o1/v/t2/f2/m366/AQPMHFeiZ7eLWAaUSfl9UjSZ2QaJHkx2VTZvZtGQn2Lri3AqZsR0B4SYnzTlS8BwXd3tu…"],
    "versions": 1,
    "advertiserDescription": "www.youtube.com/@TheNordstromRack\nwww.instagram.com/nordstromrack\nwww.twitter.com/nordstromrack \nwww.",
    "advertiserCategory": "Clothing (Brand)",
    "advertiserVerification": "BLUE_VERIFIED",
    "advertiserInstagram": "nordstromrack",
    "advertiserInstagramFollowers": 1474538
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`firstShownAt`	string (ISO 8601)	The first day the ad was shown.

For every field, see the response schema on this page.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

This method is not paginated. A single request returns the complete result.

Meta ads by page: Accepts the ad’s pageId as advertiser. Scrape the ads a Facebook page runs.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json

adUrl

string

Link to the Meta Ad Library ad, like https://www.facebook.com/ads/library/?id=1234567890123456. Send this or adId.

adId

string

Meta Ad Library ad id, like 1234567890123456. Send this or adUrl.

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Meta Ads meta Ad API

Request

Response

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Billing

Pagination

Related methods