Meta Ads page API

Get the ads a Facebook page runs

curl --request POST \
  --url https://api.stophy.dev/v1/meta/ads/page \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advertiser": "https://www.facebook.com/nike"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({advertiser: 'https://www.facebook.com/nike'})
};

fetch('https://api.stophy.dev/v1/meta/ads/page', 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/page"

payload = { "advertiser": "https://www.facebook.com/nike" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "adUrl": "<string>",
        "isActive": true,
        "versions": 0,
        "adId": "<string>",
        "advertiserId": "<string>",
        "advertiserName": "<string>",
        "advertiserUrl": "<string>",
        "advertiserAvatarUrl": "<string>",
        "pageId": "<string>",
        "pageName": "<string>",
        "pageUrl": "<string>",
        "pageAvatarUrl": "<string>",
        "pageCategories": [
          "<string>"
        ],
        "pageLikes": 0,
        "firstShownAt": "2023-11-07T05:31:56Z",
        "lastShownAt": "2023-11-07T05:31:56Z",
        "platforms": [
          "<string>"
        ],
        "format": "<string>",
        "text": "<string>",
        "linkUrl": "<string>",
        "linkTitle": "<string>",
        "linkDescription": "<string>",
        "ctaText": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "videoUrls": [
          "<string>"
        ],
        "cards": [
          {
            "text": "<string>",
            "linkUrl": "<string>",
            "linkTitle": "<string>",
            "ctaText": "<string>",
            "imageUrl": "<string>",
            "videoUrl": "<string>"
          }
        ],
        "categories": [
          "<string>"
        ],
        "paidBy": "<string>",
        "spendMin": 0,
        "spendMax": 0,
        "spendCurrency": "<string>",
        "impressionsMin": 0,
        "impressionsMax": 0,
        "reachMin": 0,
        "reachMax": 0,
        "countries": [
          "<string>"
        ]
      }
    ],
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

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

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

POST

meta

ads

page

Get the ads a Facebook page runs

curl --request POST \
  --url https://api.stophy.dev/v1/meta/ads/page \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advertiser": "https://www.facebook.com/nike"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({advertiser: 'https://www.facebook.com/nike'})
};

fetch('https://api.stophy.dev/v1/meta/ads/page', 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/page"

payload = { "advertiser": "https://www.facebook.com/nike" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "adUrl": "<string>",
        "isActive": true,
        "versions": 0,
        "adId": "<string>",
        "advertiserId": "<string>",
        "advertiserName": "<string>",
        "advertiserUrl": "<string>",
        "advertiserAvatarUrl": "<string>",
        "pageId": "<string>",
        "pageName": "<string>",
        "pageUrl": "<string>",
        "pageAvatarUrl": "<string>",
        "pageCategories": [
          "<string>"
        ],
        "pageLikes": 0,
        "firstShownAt": "2023-11-07T05:31:56Z",
        "lastShownAt": "2023-11-07T05:31:56Z",
        "platforms": [
          "<string>"
        ],
        "format": "<string>",
        "text": "<string>",
        "linkUrl": "<string>",
        "linkTitle": "<string>",
        "linkDescription": "<string>",
        "ctaText": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "videoUrls": [
          "<string>"
        ],
        "cards": [
          {
            "text": "<string>",
            "linkUrl": "<string>",
            "linkTitle": "<string>",
            "ctaText": "<string>",
            "imageUrl": "<string>",
            "videoUrl": "<string>"
          }
        ],
        "categories": [
          "<string>"
        ],
        "paidBy": "<string>",
        "spendMin": 0,
        "spendMax": 0,
        "spendCurrency": "<string>",
        "impressionsMin": 0,
        "impressionsMax": 0,
        "reachMin": 0,
        "reachMax": 0,
        "countries": [
          "<string>"
        ]
      }
    ],
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

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

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

Endpoint: meta.ads.page
Returns: data has results.
Cost: 1 credit per call. Failed calls cost nothing.
Paging: Yes. Send the cursor from the response to get the next page. See Page through results.

Example

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.meta.ads.page({ advertiser: "https://www.facebook.com/nike" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.meta.ads.page(advertiser="https://www.facebook.com/nike")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/meta/ads/page \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"advertiser":"https://www.facebook.com/nike"}'

stophy meta ads page https://www.facebook.com/nike

Authorizations

Authorization

string

header

required

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

Body

application/json

advertiser

string

required

The Facebook page: its id, name or URL.

country

string

default:us

ISO 3166-1 alpha-2 country code, or all. Any case is accepted.

Pattern: ^(?:[A-Za-z]{2}|[Aa][Ll][Ll])$

status

enum<string>

default:active

Available options:

active,

inactive,

all

mediaType

enum<string>

Only ads with this creative: image, video, or text (no image or video).

Available options:

image,

video,

text

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

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 page API

Example

Authorizations

Body

Response

​Example

Authorizations

Body

Response

Example