Pinterest search API

Search pins

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

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

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

payload = { "query": "kitchen ideas" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "pinUrl": "<string>",
        "isPromoted": true,
        "pinId": "<string>",
        "title": "<string>",
        "text": "<string>",
        "altText": "<string>",
        "linkUrl": "<string>",
        "domain": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "imageUrl": "<string>",
        "imageWidth": 0,
        "imageHeight": 0,
        "dominantColor": "<string>",
        "videoUrl": "<string>",
        "videoDurationSeconds": 123,
        "reactions": 0,
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorName": "<string>",
        "authorUrl": "<string>",
        "authorAvatarUrl": "<string>",
        "authorIsVerified": true,
        "boardId": "<string>",
        "boardName": "<string>",
        "boardUrl": "<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

Search pins

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

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

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

payload = { "query": "kitchen ideas" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "pinUrl": "<string>",
        "isPromoted": true,
        "pinId": "<string>",
        "title": "<string>",
        "text": "<string>",
        "altText": "<string>",
        "linkUrl": "<string>",
        "domain": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "imageUrl": "<string>",
        "imageWidth": 0,
        "imageHeight": 0,
        "dominantColor": "<string>",
        "videoUrl": "<string>",
        "videoDurationSeconds": 123,
        "reactions": 0,
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorName": "<string>",
        "authorUrl": "<string>",
        "authorAvatarUrl": "<string>",
        "authorIsVerified": true,
        "boardId": "<string>",
        "boardName": "<string>",
        "boardUrl": "<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 pins.

Request

query is required.

import { Stophy } from "stophy";

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

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.pinterest.search(query="kitchen ideas")
print(result["data"]["results"])

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

stophy pinterest search "kitchen ideas"

Response

If successful, the response body contains the standard envelope. data.results[] contains the pins or videos, each with its image, link and author. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "pinId": "1009298966511632539",
        "pinUrl": "https://www.pinterest.com/pin/1009298966511632539/",
        "title": "Explore Montauk Gin 2x8 White Ceramic Subway Wall Tile with Mixed Finish",
        "text": "The Montauk Gin 2x8 White Ceramic Wall Tile reimagines the subway format in durable ceramic—with a distinctively…",
        "altText": "a kitchen with wooden cabinets and white counter tops",
        "linkUrl": "https://www.tilebar.com/montauk-gin-2x8-ceramic-wall-tile-satin.html",
        "domain": "tilebar.com",
        "publishedAt": "2026-09-30T17:05:55.000Z",
        "imageUrl": "https://i.pinimg.com/originals/bc/54/e8/bc54e89cd5e3e093314c3349401ec38e.png",
        "imageWidth": 1000,
        "imageHeight": 1600,
        "dominantColor": "#846c4c",
        "reactions": 55,
        "isPromoted": false,
        "authorId": "1009299103898863825",
        "authorUsername": "ibanezpereza",
        "authorName": "Ibanezperez Ana",
        "authorUrl": "https://www.pinterest.com/ibanezpereza/",
        "authorAvatarUrl": "https://s.pinimg.com/images/user/default_140.png",
        "boardId": "1009299035180023573",
        "boardName": "Guardado rápido",
        "boardUrl": "https://www.pinterest.com/ibanezpereza/_quick_saves/"
      }
    ],
    "cursor": "Y2JVSG81V2sxcmNHRlpWM1J5VFVad1YxWllaR3hpVmtZMldWVlZNV0ZIUlhoV2FscFhVa1ZhVkZWdE1WZFdhekZWVjJ4V1YxSlZjRkZYYkdONFlXMVJlRlZ…"
  },
  "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.
`publishedAt`	string (ISO 8601)	The publication time, in UTC.

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

Optional parameters

Parameter	Type	Description
`type`	string	Pins or videos. Acceptable values are `pins` and `videos`. If unset, defaults to `pins`.
`cursor`	string	The pagination token from the previous response.

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 pin: Accepts pinUrl. Returns a pin’s details.
Pinterest board: Accepts boardUrl. Returns a board and a page of its pins.
Pinterest profile: Accepts userUrl. Returns a profile and a page of its pins.

Authorizations

Authorization

string

header

required

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

Body

application/json

query

string

required

Required string length: 1 - 200

type

enum<string>

default:pins

Available options:

pins,

videos

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