Pinterest pin API

Get a pin's details

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pinUrl": "<string>",
  "pinId": "<string>"
}
'

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

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

import requests

url = "https://api.stophy.dev/v1/pinterest/pin"

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

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

print(response.text)

{
  "success": true,
  "data": {
    "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,
    "saves": 0,
    "reposts": 0,
    "comments": 0,
    "reactions": 0,
    "authorId": "<string>",
    "authorUsername": "<string>",
    "authorName": "<string>",
    "authorUrl": "<string>",
    "authorAvatarUrl": "<string>",
    "authorIsVerified": true,
    "boardId": "<string>",
    "boardName": "<string>",
    "boardUrl": "<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

Get a pin's details

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pinUrl": "<string>",
  "pinId": "<string>"
}
'

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

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

import requests

url = "https://api.stophy.dev/v1/pinterest/pin"

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

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

print(response.text)

{
  "success": true,
  "data": {
    "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,
    "saves": 0,
    "reposts": 0,
    "comments": 0,
    "reactions": 0,
    "authorId": "<string>",
    "authorUsername": "<string>",
    "authorName": "<string>",
    "authorUrl": "<string>",
    "authorAvatarUrl": "<string>",
    "authorIsVerified": true,
    "boardId": "<string>",
    "boardName": "<string>",
    "boardUrl": "<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"
  }
}

Returns a pin’s details. The pin is identified by its URL or ID.

Request

Exactly one of pinUrl or pinId 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.pin({ pinUrl: "https://www.pinterest.com/pin/1234567890123456/" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.pinterest.pin(pin_url="https://www.pinterest.com/pin/1234567890123456/")
print(result["data"])

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

stophy pinterest pin --pinUrl https://www.pinterest.com/pin/1234567890123456/

Response

If successful, the response body contains the standard envelope. data contains the pin’s image, link, saves and author. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "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…",
    "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",
    "saves": 6250,
    "reposts": 11,
    "comments": 3,
    "reactions": 55,
    "isPromoted": false,
    "authorId": "101049722797560631",
    "authorUsername": "TileBar",
    "authorName": "TileBar",
    "authorUrl": "https://www.pinterest.com/TileBar/",
    "authorAvatarUrl": "https://i.pinimg.com/75x75_RS/8f/8a/2c/8f8a2c4d5a9240a454dd99d3703bc0eb.jpg",
    "boardId": "1009299035180023573",
    "boardName": "Guardado rápido",
    "boardUrl": "https://www.pinterest.com/ibanezpereza/_quick_saves/"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`publishedAt`	string (ISO 8601)	The publication time, in UTC.

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

pinUrl

string

Link to the Pinterest pin, like https://www.pinterest.com/pin/1234567890123456/. Send this or pinId.

pinId

string

Pinterest pin id, like 1234567890123456. Send this or pinUrl.

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

Request

Response

Billing

Authorizations

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Billing

Pagination

Related methods