Pinterest search ads API

Search ads in the Pinterest ads library

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/ads/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "DE"
}
'

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

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

payload = { "country": "DE" }
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>",
        "isCommercial": true,
        "adId": "<string>",
        "headline": "<string>",
        "text": "<string>",
        "advertisers": [
          "<string>"
        ],
        "imageUrl": "<string>",
        "videoUrl": "<string>",
        "links": [
          "<string>"
        ],
        "firstShownAt": "2023-11-07T05:31:56Z",
        "lastShownAt": "2023-11-07T05:31:56Z",
        "reachMin": 0,
        "reachMax": 0,
        "reachByCountry": [
          {
            "country": "<string>",
            "reachMin": 0,
            "reachMax": 0
          }
        ],
        "countries": [
          "<string>"
        ],
        "ageRanges": [
          "<string>"
        ],
        "genders": [
          "<string>"
        ],
        "interests": [
          "<string>"
        ],
        "audienceTypes": [
          "<string>"
        ]
      }
    ],
    "cursor": "<string>"
  },
  "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

Search ads in the Pinterest ads library

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/ads/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "DE"
}
'

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

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

payload = { "country": "DE" }
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>",
        "isCommercial": true,
        "adId": "<string>",
        "headline": "<string>",
        "text": "<string>",
        "advertisers": [
          "<string>"
        ],
        "imageUrl": "<string>",
        "videoUrl": "<string>",
        "links": [
          "<string>"
        ],
        "firstShownAt": "2023-11-07T05:31:56Z",
        "lastShownAt": "2023-11-07T05:31:56Z",
        "reachMin": 0,
        "reachMax": 0,
        "reachByCountry": [
          {
            "country": "<string>",
            "reachMin": 0,
            "reachMax": 0
          }
        ],
        "countries": [
          "<string>"
        ],
        "ageRanges": [
          "<string>"
        ],
        "genders": [
          "<string>"
        ],
        "interests": [
          "<string>"
        ],
        "audienceTypes": [
          "<string>"
        ]
      }
    ],
    "cursor": "<string>"
  },
  "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"
  }
}

Searches ads in the Pinterest ads library.

Request

country is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.pinterest.ads.search({ country: "DE" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.pinterest.ads.search(country="DE")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/pinterest/ads/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"country":"DE"}'

stophy pinterest ads search DE

Response

If successful, the response body contains the standard envelope. data.results[] contains the ads, each with its 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": {
    "results": [
      {
        "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…",
        "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", "FEMALE"],
        "audienceTypes": ["VISITOR"],
        "isCommercial": true
      }
    ],
    "cursor": "P2gxcHw4MzE2MjkzNTczN3wyODM0MDU3NDU2MzMxNjEzKkdRTCp8ZThiZTg3YzI1NWNlYzY0YzUyNDNhODczOWVmZTk3YjNkNWE4YmVjZjJmOGZjOTc5NTF…"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`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.

Optional parameters

Parameter	Type	Description
`advertiser`	string	Restricts results to ads from this advertiser. Results do not name the advertiser.
`cursor`	string	The pagination token from the previous response.

This method filters by country and advertiser. Keyword search is not supported.

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

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

Pinterest ad details: Accepts adUrl. Returns a Pinterest ad’s details.

Authorizations

Authorization

string

header

required

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

Body

application/json

country

string

required

EU country code like fr, or br or tr. Pinterest publishes ads for these countries only. Any case is accepted.

Pattern: ^[A-Za-z]{2}$

advertiser

string

Advertiser name to filter by. Pinterest does not publish advertiser names on the ads themselves, so results carry no advertiser.

Required string length: 1 - 200

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

Pinterest search ads API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods