Pinterest ad API

Get a Pinterest ad's details

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/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/pinterest/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/pinterest/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>",
    "advertisers": [
      "<string>"
    ],
    "links": [
      "<string>"
    ],
    "reachByCountry": [
      {
        "country": "<string>",
        "reachMin": 0,
        "reachMax": 0
      }
    ],
    "countries": [
      "<string>"
    ],
    "ageRanges": [
      "<string>"
    ],
    "genders": [
      "<string>"
    ],
    "interests": [
      "<string>"
    ],
    "audienceTypes": [
      "<string>"
    ],
    "isCommercial": true,
    "adId": "<string>",
    "headline": "<string>",
    "text": "<string>",
    "imageUrl": "<string>",
    "videoUrl": "<string>",
    "firstShownAt": "2023-11-07T05:31:56Z",
    "lastShownAt": "2023-11-07T05:31:56Z",
    "reachMin": 0,
    "reachMax": 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

ads

Get a Pinterest ad's details

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/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/pinterest/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/pinterest/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>",
    "advertisers": [
      "<string>"
    ],
    "links": [
      "<string>"
    ],
    "reachByCountry": [
      {
        "country": "<string>",
        "reachMin": 0,
        "reachMax": 0
      }
    ],
    "countries": [
      "<string>"
    ],
    "ageRanges": [
      "<string>"
    ],
    "genders": [
      "<string>"
    ],
    "interests": [
      "<string>"
    ],
    "audienceTypes": [
      "<string>"
    ],
    "isCommercial": true,
    "adId": "<string>",
    "headline": "<string>",
    "text": "<string>",
    "imageUrl": "<string>",
    "videoUrl": "<string>",
    "firstShownAt": "2023-11-07T05:31:56Z",
    "lastShownAt": "2023-11-07T05:31:56Z",
    "reachMin": 0,
    "reachMax": 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"
  }
}

Returns a Pinterest 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.pinterest.ads.ad({ adUrl: "https://ads.pinterest.com/ads-repository/1234567890123456/" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.pinterest.ads.ad(ad_url="https://ads.pinterest.com/ads-repository/1234567890123456/")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/pinterest/ads/ad \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"adUrl":"https://ads.pinterest.com/ads-repository/1234567890123456/"}'

stophy pinterest ads ad --adUrl https://ads.pinterest.com/ads-repository/1234567890123456/

Response

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

{
  "success": true,
  "data": {
    "adId": "4593179166442157824",
    "adUrl": "https://ads.pinterest.com/ads-repository/4593179166442157824/",
    "headline": "Das Mädchen vom Moorhof",
    "text": "Schweden, um 1900: Die Magd Helga erwartet ein Kind. Die junge Häuslerin hat auf einem Hof im Värmland gearbeitet, der…",
    "advertisers": ["Thalia Bücher GmbH"],
    "imageUrl": "https://i.pinimg.com/474x/62/b8/37/62b837bc76a44632ce732e03b88b8d50.jpg",
    "firstShownAt": "2026-02-18T00:00:00.000Z",
    "lastShownAt": "2026-10-02T00:00:00.000Z",
    "reachMin": 0,
    "reachMax": 10000,
    "reachByCountry": [
      {
        "country": "Germany",
        "reachMin": 0,
        "reachMax": 10000
      }
    ],
    "countries": ["Germany"],
    "ageRanges": ["18+"],
    "genders": ["UNSPECIFIED"],
    "audienceTypes": ["VISITOR"],
    "isCommercial": true
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`firstShownAt`	string (ISO 8601)	The first day the ad was shown.
`lastShownAt`	string (ISO 8601)	The last day the ad was shown.
`reachMin`	integer	With `reachMax`, the range for the number of people the ad reached.
`countries`	string[]	The countries in which 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.

Pinterest ads search: Accepts one of the countries as country. Searches ads in the Pinterest ads library.

Authorizations

Authorization

string

header

required

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

Body

application/json

adUrl

string

Link to the Pinterest ad, like https://ads.pinterest.com/ads-repository/1234567890123456/. Send this or adId.

adId

string

Pinterest 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

Pinterest ad API

Request

Response

Billing

Authorizations

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Billing

Pagination

Related methods